@wix/subscription 1.0.21 → 1.0.23

package/type-bundles/meta.bundle.d.ts

@@ -8,12 +8,12 @@ interface Subscription$1 {
      * Date when subscription was created
      * @readonly
      */
-    createdDate?: Date;
+    createdDate?: Date | null;
     /**
      * Date when subscription was updated
      * @readonly
      */
-    updatedDate?: Date;
+    updatedDate?: Date | null;
     /**
      * Revision of subscription. Increments upon changes
      * @readonly
@@ -29,13 +29,13 @@ interface Subscription$1 {
      * Future start_date is not supported for `SEND_INVOICE` CollectionMethod
      * If start_date is set in past, it means subscription was already started.
      */
-    startDate?: Date;
+    startDate?: Date | null;
     /**
      * Represents when the subscription will end, relevant for subscriptions with a termed period.
      * If not provided, will be calculated based on billing schedule. Should be empty for evergreen subscription.
      * Note: A 13-hour tolerance is applied when validating the end date to handle for time zone differences and minor discrepancies.
      */
-    endDate?: Date;
+    endDate?: Date | null;
     /** Business origin subscription is coming from. In site-level subscription it will be vertical app_id and entity_id */
     origin?: BusinessOrigin$1;
     /** Customer information like id and identity type (member or contact) */
@@ -446,9 +446,9 @@ interface BillingStatus$1 {
     /** how many cycled are remaining, For auto-renew subscriptions is not set. */
     remainingCycles?: number | null;
     /** Date when charge will be for next billing cycle */
-    nextBillingDate?: Date;
+    nextBillingDate?: Date | null;
     /** Previous Date charged for previous billing cycle */
-    previousBillingDate?: Date;
+    previousBillingDate?: Date | null;
     /** last payment details */
     latestPaymentData?: PaymentData$1;
     /** Free trial data */
@@ -464,7 +464,7 @@ interface PaymentData$1 {
     invoiceId?: string;
     paymentStatus?: PaymentStatus$1;
     totals?: Totals$1;
-    initialFailedPaymentDate?: Date;
+    initialFailedPaymentDate?: Date | null;
 }
 declare enum PaymentStatus$1 {
     /** Payment status unknown */
@@ -530,12 +530,12 @@ interface FreeTrialData$1 {
      * Date when free trial starts
      * @readonly
      */
-    startDate?: Date;
+    startDate?: Date | null;
     /**
      * Date when free trial ends
      * @readonly
      */
-    endDate?: Date;
+    endDate?: Date | null;
 }
 interface Proration$1 extends ProrationTypeOneOf$1 {
     /**
@@ -608,12 +608,12 @@ interface GracePeriodData$1 {
      * Grace period start date
      * @readonly
      */
-    startDate?: Date;
+    startDate?: Date | null;
     /**
      * Grace period end date
      * @readonly
      */
-    endDate?: Date;
+    endDate?: Date | null;
     /** Automatic retry data during grade period, if have any. Optional. */
     automaticRetryData?: AutomaticRetryData$1;
 }
@@ -631,10 +631,10 @@ interface SubscriptionPolicies$1 {
 interface PauseInfo$1 {
     pausePolicy?: PausePolicy$1;
     pauseAt?: PauseAt$1;
-    startDate?: Date;
+    startDate?: Date | null;
     startCycle?: number | null;
     resumeAt?: ResumeAt$1;
-    resumeDate?: Date;
+    resumeDate?: Date | null;
     resumeCycle?: number | null;
 }
 declare enum PausePolicy$1 {
@@ -668,7 +668,7 @@ declare enum ResumeAt$1 {
 }
 interface CancellationInfo$1 {
     /** Subscription cancel date. Can contain a future or past date */
-    cancellationDate?: Date;
+    cancellationDate?: Date | null;
     /** Initiator for cancellation */
     initiator?: HistoryActionInitiator$1;
     /** Reason for cancellation. Optional. */
@@ -784,7 +784,7 @@ interface ApplicationFeeValueOneOf$1 {
 }
 interface SpecificDateSubscriptionUpdateData$1 {
     updateData?: SubscriptionUpdateData$1;
-    executionDate?: Date;
+    executionDate?: Date | null;
 }
 interface ListSubscriptionHistoryRequest$1 {
     subscriptionId: string;
@@ -821,7 +821,7 @@ interface SubscriptionHistoryEntry$1 {
     entryId?: string;
     /** TODO: add max length? it is not defined in domainevents, so should we? */
     slug?: string;
-    entryTime?: Date;
+    entryTime?: Date | null;
     event?: SubscriptionEvent$1;
 }
 interface SubscriptionEvent$1 extends SubscriptionEventPayloadOneOf$1 {
@@ -1012,7 +1012,7 @@ interface SubscriptionRevived$1 {
 }
 interface SubscriptionBillingDateUpdated$1 {
     subscription?: Subscription$1;
-    billingDate?: Date;
+    billingDate?: Date | null;
     proration?: Proration$1;
 }
 interface FutureUpdatesRequested$1 {
@@ -1321,7 +1321,7 @@ interface SubscriptionCharge$1 {
     /** cycle of future charge */
     cycle?: number;
     /** date of the charge */
-    billingDate?: Date;
+    billingDate?: Date | null;
     /** breakdown of charge */
     totals?: Totals$1;
     /** List of items in the invoice */
@@ -1481,22 +1481,8 @@ interface LineItemTaxSummary$1 {
     aggregatedTaxAmount?: string;
     /** Aggregated from tax_breakdowns */
     aggregatedTaxRate?: string;
-    /** Array of each tax applied, grouped by `"jurisdiction"`, `"jurisdiction_type"`, `"tax_type"`, `"tax_name"` and `"tax_rate"`. */
-    aggregatedTaxBreakdowns?: AggregatedTaxBreakdown$1[];
-}
-interface AggregatedTaxBreakdown$1 {
-    /** Name of the tax that was calculated. */
-    taxName?: string;
-    /** Type of tax that was calculated. */
-    taxType?: string;
-    /** Jurisdiction that taxes were calculated for. */
-    jurisdiction?: string;
-    /** Type of jurisdiction that taxes were calculated for. */
-    jurisdictionType?: string;
-    /** Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is `"0.1000"` and 200% tax is `"2.0000"`. */
-    rate?: string;
-    /** Total amount of this tax for this jurisdiction. */
-    aggregatedTaxAmount?: string;
+    /** Total taxable amount for this line item. */
+    taxableAmount?: string;
 }
 interface TaxBreakdown$1 {
     taxType?: string;
@@ -1549,7 +1535,7 @@ interface UpdateSubscriptionBillingDateRequest$1 {
     /** ID of the subscription to update the billing date for. */
     id: string;
     /** New billing date in `YYYY-MM-DDThh:mm:ss:sssZ` format. */
-    billingDate: Date;
+    billingDate: Date | null;
     /**
      * Information about how BASS adjusts the total of the next invoice. Extending
      * the current billing cycle results in a higher payment, while shortening it
@@ -1574,7 +1560,7 @@ interface ScheduleAdditionalInfo$1 extends ScheduleAdditionalInfoParamOneOf$1 {
      * only in combination with `{"resumeAt": "SPECIFIC_DATE"}`, and in
      * _Pause Subscription_ only in combination with `{"pauseAt": "SPECIFIC_DATE"}`.
      */
-    specificDate?: Date;
+    specificDate?: Date | null;
     /**
      * When the update becomes effective, as number of billing cycles from now.
      * The use of this field may be restricted in various BASS endpoints.
@@ -1594,7 +1580,7 @@ interface ScheduleAdditionalInfoParamOneOf$1 {
      * only in combination with `{"resumeAt": "SPECIFIC_DATE"}`, and in
      * _Pause Subscription_ only in combination with `{"pauseAt": "SPECIFIC_DATE"}`.
      */
-    specificDate?: Date;
+    specificDate?: Date | null;
     /**
      * When the update becomes effective, as number of billing cycles from now.
      * The use of this field may be restricted in various BASS endpoints.
@@ -1754,7 +1740,7 @@ interface ListUpcomingChargesRequest$1 {
      * Date of the next billing cycle so that the upcoming charges will be calculated accordingly.
      * If not provided, the upcoming charges will be calculated according to the existing next billing date.
      */
-    nextBillingDate?: Date;
+    nextBillingDate?: Date | null;
 }
 interface ListUpcomingChargesResponse$1 {
     upcomingCharges?: SubscriptionCharge$1[];
@@ -1772,7 +1758,7 @@ interface PreviewSubscriptionChargesRequestSubscriptionOneOf$1 {
 interface SubscriptionInfo$1 {
     billingSettings?: BillingSettings$1;
     items?: Item$1[];
-    startDate?: Date;
+    startDate?: Date | null;
 }
 interface PreviewSubscriptionChargesResponse$1 {
     /** Charges for subscription. */
@@ -1787,7 +1773,7 @@ interface Charge$1 {
     /** The breakdown of the charge */
     totals?: Totals$1;
     /** The billing date from which the charge starts */
-    cycleBillingDate?: Date;
+    cycleBillingDate?: Date | null;
 }
 interface PayCycleRequest$1 {
     subscriptionId: string;
@@ -2189,19 +2175,10 @@ interface PriceDetailsNonNullableFields$1 {
     discount?: InvoiceDiscountNonNullableFields$1;
     applicationFeeDetails?: InvoiceApplicationFeeNonNullableFields$1;
 }
-interface AggregatedTaxBreakdownNonNullableFields$1 {
-    taxName: string;
-    taxType: string;
-    jurisdiction: string;
-    jurisdictionType: string;
-    rate: string;
-    aggregatedTaxAmount: string;
-    aggregatedTaxableAmount: string;
-}
 interface LineItemTaxSummaryNonNullableFields$1 {
     aggregatedTaxAmount: string;
     aggregatedTaxRate: string;
-    aggregatedTaxBreakdowns: AggregatedTaxBreakdownNonNullableFields$1[];
+    taxableAmount: string;
 }
 interface TaxBreakdownNonNullableFields$1 {
     taxType: string;
@@ -2314,12 +2291,12 @@ interface Subscription {
      * Date when subscription was created
      * @readonly
      */
-    _createdDate?: Date;
+    _createdDate?: Date | null;
     /**
      * Date when subscription was updated
      * @readonly
      */
-    _updatedDate?: Date;
+    _updatedDate?: Date | null;
     /**
      * Revision of subscription. Increments upon changes
      * @readonly
@@ -2335,13 +2312,13 @@ interface Subscription {
      * Future start_date is not supported for `SEND_INVOICE` CollectionMethod
      * If start_date is set in past, it means subscription was already started.
      */
-    startDate?: Date;
+    startDate?: Date | null;
     /**
      * Represents when the subscription will end, relevant for subscriptions with a termed period.
      * If not provided, will be calculated based on billing schedule. Should be empty for evergreen subscription.
      * Note: A 13-hour tolerance is applied when validating the end date to handle for time zone differences and minor discrepancies.
      */
-    endDate?: Date;
+    endDate?: Date | null;
     /** Business origin subscription is coming from. In site-level subscription it will be vertical app_id and entity_id */
     origin?: BusinessOrigin;
     /** Customer information like id and identity type (member or contact) */
@@ -2752,9 +2729,9 @@ interface BillingStatus {
     /** how many cycled are remaining, For auto-renew subscriptions is not set. */
     remainingCycles?: number | null;
     /** Date when charge will be for next billing cycle */
-    nextBillingDate?: Date;
+    nextBillingDate?: Date | null;
     /** Previous Date charged for previous billing cycle */
-    previousBillingDate?: Date;
+    previousBillingDate?: Date | null;
     /** last payment details */
     latestPaymentData?: PaymentData;
     /** Free trial data */
@@ -2770,7 +2747,7 @@ interface PaymentData {
     invoiceId?: string;
     paymentStatus?: PaymentStatus;
     totals?: Totals;
-    initialFailedPaymentDate?: Date;
+    initialFailedPaymentDate?: Date | null;
 }
 declare enum PaymentStatus {
     /** Payment status unknown */
@@ -2836,12 +2813,12 @@ interface FreeTrialData {
      * Date when free trial starts
      * @readonly
      */
-    startDate?: Date;
+    startDate?: Date | null;
     /**
      * Date when free trial ends
      * @readonly
      */
-    endDate?: Date;
+    endDate?: Date | null;
 }
 interface Proration extends ProrationTypeOneOf {
     /**
@@ -2914,12 +2891,12 @@ interface GracePeriodData {
      * Grace period start date
      * @readonly
      */
-    startDate?: Date;
+    startDate?: Date | null;
     /**
      * Grace period end date
      * @readonly
      */
-    endDate?: Date;
+    endDate?: Date | null;
     /** Automatic retry data during grade period, if have any. Optional. */
     automaticRetryData?: AutomaticRetryData;
 }
@@ -2937,10 +2914,10 @@ interface SubscriptionPolicies {
 interface PauseInfo {
     pausePolicy?: PausePolicy;
     pauseAt?: PauseAt;
-    startDate?: Date;
+    startDate?: Date | null;
     startCycle?: number | null;
     resumeAt?: ResumeAt;
-    resumeDate?: Date;
+    resumeDate?: Date | null;
     resumeCycle?: number | null;
 }
 declare enum PausePolicy {
@@ -2974,7 +2951,7 @@ declare enum ResumeAt {
 }
 interface CancellationInfo {
     /** Subscription cancel date. Can contain a future or past date */
-    cancellationDate?: Date;
+    cancellationDate?: Date | null;
     /** Initiator for cancellation */
     initiator?: HistoryActionInitiator;
     /** Reason for cancellation. Optional. */
@@ -3090,7 +3067,7 @@ interface ApplicationFeeValueOneOf {
 }
 interface SpecificDateSubscriptionUpdateData {
     updateData?: SubscriptionUpdateData;
-    executionDate?: Date;
+    executionDate?: Date | null;
 }
 interface ListSubscriptionHistoryRequest {
     subscriptionId: string;
@@ -3127,7 +3104,7 @@ interface SubscriptionHistoryEntry {
     entryId?: string;
     /** TODO: add max length? it is not defined in domainevents, so should we? */
     slug?: string;
-    entryTime?: Date;
+    entryTime?: Date | null;
     event?: SubscriptionEvent;
 }
 interface SubscriptionEvent extends SubscriptionEventPayloadOneOf {
@@ -3318,7 +3295,7 @@ interface SubscriptionRevived {
 }
 interface SubscriptionBillingDateUpdated {
     subscription?: Subscription;
-    billingDate?: Date;
+    billingDate?: Date | null;
     proration?: Proration;
 }
 interface FutureUpdatesRequested {
@@ -3627,7 +3604,7 @@ interface SubscriptionCharge {
     /** cycle of future charge */
     cycle?: number;
     /** date of the charge */
-    billingDate?: Date;
+    billingDate?: Date | null;
     /** breakdown of charge */
     totals?: Totals;
     /** List of items in the invoice */
@@ -3787,22 +3764,8 @@ interface LineItemTaxSummary {
     aggregatedTaxAmount?: string;
     /** Aggregated from tax_breakdowns */
     aggregatedTaxRate?: string;
-    /** Array of each tax applied, grouped by `"jurisdiction"`, `"jurisdiction_type"`, `"tax_type"`, `"tax_name"` and `"tax_rate"`. */
-    aggregatedTaxBreakdowns?: AggregatedTaxBreakdown[];
-}
-interface AggregatedTaxBreakdown {
-    /** Name of the tax that was calculated. */
-    taxName?: string;
-    /** Type of tax that was calculated. */
-    taxType?: string;
-    /** Jurisdiction that taxes were calculated for. */
-    jurisdiction?: string;
-    /** Type of jurisdiction that taxes were calculated for. */
-    jurisdictionType?: string;
-    /** Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is `"0.1000"` and 200% tax is `"2.0000"`. */
-    rate?: string;
-    /** Total amount of this tax for this jurisdiction. */
-    aggregatedTaxAmount?: string;
+    /** Total taxable amount for this line item. */
+    taxableAmount?: string;
 }
 interface TaxBreakdown {
     taxType?: string;
@@ -3855,7 +3818,7 @@ interface UpdateSubscriptionBillingDateRequest {
     /** ID of the subscription to update the billing date for. */
     _id: string;
     /** New billing date in `YYYY-MM-DDThh:mm:ss:sssZ` format. */
-    billingDate: Date;
+    billingDate: Date | null;
     /**
      * Information about how BASS adjusts the total of the next invoice. Extending
      * the current billing cycle results in a higher payment, while shortening it
@@ -3880,7 +3843,7 @@ interface ScheduleAdditionalInfo extends ScheduleAdditionalInfoParamOneOf {
      * only in combination with `{"resumeAt": "SPECIFIC_DATE"}`, and in
      * _Pause Subscription_ only in combination with `{"pauseAt": "SPECIFIC_DATE"}`.
      */
-    specificDate?: Date;
+    specificDate?: Date | null;
     /**
      * When the update becomes effective, as number of billing cycles from now.
      * The use of this field may be restricted in various BASS endpoints.
@@ -3900,7 +3863,7 @@ interface ScheduleAdditionalInfoParamOneOf {
      * only in combination with `{"resumeAt": "SPECIFIC_DATE"}`, and in
      * _Pause Subscription_ only in combination with `{"pauseAt": "SPECIFIC_DATE"}`.
      */
-    specificDate?: Date;
+    specificDate?: Date | null;
     /**
      * When the update becomes effective, as number of billing cycles from now.
      * The use of this field may be restricted in various BASS endpoints.
@@ -4060,7 +4023,7 @@ interface ListUpcomingChargesRequest {
      * Date of the next billing cycle so that the upcoming charges will be calculated accordingly.
      * If not provided, the upcoming charges will be calculated according to the existing next billing date.
      */
-    nextBillingDate?: Date;
+    nextBillingDate?: Date | null;
 }
 interface ListUpcomingChargesResponse {
     upcomingCharges?: SubscriptionCharge[];
@@ -4078,7 +4041,7 @@ interface PreviewSubscriptionChargesRequestSubscriptionOneOf {
 interface SubscriptionInfo {
     billingSettings?: BillingSettings;
     items?: Item[];
-    startDate?: Date;
+    startDate?: Date | null;
 }
 interface PreviewSubscriptionChargesResponse {
     /** Charges for subscription. */
@@ -4093,7 +4056,7 @@ interface Charge {
     /** The breakdown of the charge */
     totals?: Totals;
     /** The billing date from which the charge starts */
-    cycleBillingDate?: Date;
+    cycleBillingDate?: Date | null;
 }
 interface PayCycleRequest {
     subscriptionId: string;
@@ -4495,19 +4458,10 @@ interface PriceDetailsNonNullableFields {
     discount?: InvoiceDiscountNonNullableFields;
     applicationFeeDetails?: InvoiceApplicationFeeNonNullableFields;
 }
-interface AggregatedTaxBreakdownNonNullableFields {
-    taxName: string;
-    taxType: string;
-    jurisdiction: string;
-    jurisdictionType: string;
-    rate: string;
-    aggregatedTaxAmount: string;
-    aggregatedTaxableAmount: string;
-}
 interface LineItemTaxSummaryNonNullableFields {
     aggregatedTaxAmount: string;
     aggregatedTaxRate: string;
-    aggregatedTaxBreakdowns: AggregatedTaxBreakdownNonNullableFields[];
+    taxableAmount: string;
 }
 interface TaxBreakdownNonNullableFields {
     taxType: string;