@epcc-sdk/sdks-shopper 0.6.1 → 0.7.0

package/dist/client/types.gen.d.cts

@@ -5997,6 +5997,10 @@ type ProrationPolicyAttributes = {
      */
     rounding: "up" | "down" | "nearest";
     external_ref?: ExternalRef;
+    /**
+     * Set to `true` to allow an automatic gateway refund when a proration would otherwise be rejected for netting negative.
+     */
+    allow_negative_proration_refund?: boolean;
 };
 type ProrationPolicyUpdateAttributes = {
     external_ref?: ExternalRefUpdate;
@@ -6008,6 +6012,10 @@ type ProrationPolicyUpdateAttributes = {
      * Whether to round up or down
      */
     rounding?: "up" | "down" | "nearest";
+    /**
+     * Set to `true` to allow an automatic gateway refund when a proration would otherwise be rejected for netting negative.
+     */
+    allow_negative_proration_refund?: boolean;
 };
 type ProrationPolicyMeta = {
     owner: OwnerMeta;
@@ -6051,11 +6059,11 @@ type PricingOptionAttributes = {
      */
     end_behavior: "close" | "roll";
     /**
-     * Reserved for a future release. Intended to control whether a subscriber can pause a subscription, but currently has no effect — subscription pausing is only available to merchandizers, regardless of this value.
+     * The subscriber can pause a subscription.
      */
     can_pause: boolean;
     /**
-     * Reserved for a future release. Intended to control whether a subscriber can resume a paused subscription, but currently has no effect — subscription resuming is only available to merchandizers, regardless of this value.
+     * The subscriber can resume a paused subscription.
      */
     can_resume: boolean;
     /**
@@ -6098,11 +6106,11 @@ type PricingOptionUpdateAttributes = {
      */
     end_behavior?: "close" | "roll";
     /**
-     * Reserved for a future release. Intended to control whether a subscriber can pause a subscription, but currently has no effect — subscription pausing is only available to merchandizers, regardless of this value.
+     * The subscriber can pause a subscription.
      */
     can_pause?: boolean;
     /**
-     * Reserved for a future release. Intended to control whether a subscriber can resume a paused subscription, but currently has no effect — subscription resuming is only available to merchandizers, regardless of this value.
+     * The subscriber can resume a paused subscription.
      */
     can_resume?: boolean;
     /**
@@ -6448,6 +6456,18 @@ type SubscriptionMeta = {
      * A history of price updates that have been applied to this subscription.
      */
     price_update_history?: Array<SubscriptionPriceUpdateHistoryEntry>;
+    /**
+     * The ID of the most recent Proration Refund issued for this subscription, if any.
+     */
+    last_refund_id?: string;
+    /**
+     * The amount of the most recent Proration Refund issued for this subscription, if any.
+     */
+    last_refund_amount?: number;
+    /**
+     * Who or what most recently paused this subscription, while it remains paused. Absent when the subscription has never been paused, or is not currently paused (cleared on resume). Only visible to merchandizer/store or organization-scoped callers.
+     */
+    paused_by?: "subscriber" | "merchandizer" | "dunning";
 };
 type SubscriptionTimestamps = SubscriptionsTimestamps & {
     /**
@@ -6563,12 +6583,28 @@ type ProrationPreviewAttributes = {
      * Whether submitting this prospective change would actually result in a proration.
      */
     would_prorate: boolean;
+    /**
+     * Whether this change would result in a Proration Refund - a real refund issued against the
+     * subscription's previous invoice payment because the unused-time credit exceeds the new pricing
+     * option's cost. Set alongside `would_prorate: true` for this case; omitted otherwise.
+     *
+     */
+    would_refund?: boolean | null;
+    /**
+     * The amount that would be refunded as a Proration Refund, as a whole number of the currency's
+     * smallest subdivision. Set only when `would_refund` is `true`.
+     *
+     */
+    refund_amount?: number | null;
     /**
      * Why a previewed change would not result in a proration if actually submitted. Returned alongside
-     * `would_prorate: false`; this is not an error response.
+     * `would_prorate: false`; this is not an error response. `negative_amount` is retained for backward
+     * compatibility but is no longer returned - a negative-net change now either proceeds with a
+     * Proration Refund (`would_refund: true`), is rejected as `refund_not_possible`, or is rejected as
+     * `refund_disallowed_by_policy` when the applicable proration policy does not allow refunds.
      *
      */
-    rejection_reason: "negative_amount" | "no_change";
+    rejection_reason: "negative_amount" | "no_change" | "refund_not_possible" | "refund_disallowed_by_policy";
     /**
      * The value as a whole number of the currency's smallest subdivision.
      */
@@ -11702,6 +11738,18 @@ type SubscriptionMetaWritable = {
      * A history of price updates that have been applied to this subscription.
      */
     price_update_history?: Array<SubscriptionPriceUpdateHistoryEntry>;
+    /**
+     * The ID of the most recent Proration Refund issued for this subscription, if any.
+     */
+    last_refund_id?: string;
+    /**
+     * The amount of the most recent Proration Refund issued for this subscription, if any.
+     */
+    last_refund_amount?: number;
+    /**
+     * Who or what most recently paused this subscription, while it remains paused. Absent when the subscription has never been paused, or is not currently paused (cleared on resume). Only visible to merchandizer/store or organization-scoped callers.
+     */
+    paused_by?: "subscriber" | "merchandizer" | "dunning";
 };
 type SubscriptionAttributesWritable = {
     external_ref?: ExternalRef;

package/dist/client/types.gen.d.ts

@@ -5997,6 +5997,10 @@ type ProrationPolicyAttributes = {
      */
     rounding: "up" | "down" | "nearest";
     external_ref?: ExternalRef;
+    /**
+     * Set to `true` to allow an automatic gateway refund when a proration would otherwise be rejected for netting negative.
+     */
+    allow_negative_proration_refund?: boolean;
 };
 type ProrationPolicyUpdateAttributes = {
     external_ref?: ExternalRefUpdate;
@@ -6008,6 +6012,10 @@ type ProrationPolicyUpdateAttributes = {
      * Whether to round up or down
      */
     rounding?: "up" | "down" | "nearest";
+    /**
+     * Set to `true` to allow an automatic gateway refund when a proration would otherwise be rejected for netting negative.
+     */
+    allow_negative_proration_refund?: boolean;
 };
 type ProrationPolicyMeta = {
     owner: OwnerMeta;
@@ -6051,11 +6059,11 @@ type PricingOptionAttributes = {
      */
     end_behavior: "close" | "roll";
     /**
-     * Reserved for a future release. Intended to control whether a subscriber can pause a subscription, but currently has no effect — subscription pausing is only available to merchandizers, regardless of this value.
+     * The subscriber can pause a subscription.
      */
     can_pause: boolean;
     /**
-     * Reserved for a future release. Intended to control whether a subscriber can resume a paused subscription, but currently has no effect — subscription resuming is only available to merchandizers, regardless of this value.
+     * The subscriber can resume a paused subscription.
      */
     can_resume: boolean;
     /**
@@ -6098,11 +6106,11 @@ type PricingOptionUpdateAttributes = {
      */
     end_behavior?: "close" | "roll";
     /**
-     * Reserved for a future release. Intended to control whether a subscriber can pause a subscription, but currently has no effect — subscription pausing is only available to merchandizers, regardless of this value.
+     * The subscriber can pause a subscription.
      */
     can_pause?: boolean;
     /**
-     * Reserved for a future release. Intended to control whether a subscriber can resume a paused subscription, but currently has no effect — subscription resuming is only available to merchandizers, regardless of this value.
+     * The subscriber can resume a paused subscription.
      */
     can_resume?: boolean;
     /**
@@ -6448,6 +6456,18 @@ type SubscriptionMeta = {
      * A history of price updates that have been applied to this subscription.
      */
     price_update_history?: Array<SubscriptionPriceUpdateHistoryEntry>;
+    /**
+     * The ID of the most recent Proration Refund issued for this subscription, if any.
+     */
+    last_refund_id?: string;
+    /**
+     * The amount of the most recent Proration Refund issued for this subscription, if any.
+     */
+    last_refund_amount?: number;
+    /**
+     * Who or what most recently paused this subscription, while it remains paused. Absent when the subscription has never been paused, or is not currently paused (cleared on resume). Only visible to merchandizer/store or organization-scoped callers.
+     */
+    paused_by?: "subscriber" | "merchandizer" | "dunning";
 };
 type SubscriptionTimestamps = SubscriptionsTimestamps & {
     /**
@@ -6563,12 +6583,28 @@ type ProrationPreviewAttributes = {
      * Whether submitting this prospective change would actually result in a proration.
      */
     would_prorate: boolean;
+    /**
+     * Whether this change would result in a Proration Refund - a real refund issued against the
+     * subscription's previous invoice payment because the unused-time credit exceeds the new pricing
+     * option's cost. Set alongside `would_prorate: true` for this case; omitted otherwise.
+     *
+     */
+    would_refund?: boolean | null;
+    /**
+     * The amount that would be refunded as a Proration Refund, as a whole number of the currency's
+     * smallest subdivision. Set only when `would_refund` is `true`.
+     *
+     */
+    refund_amount?: number | null;
     /**
      * Why a previewed change would not result in a proration if actually submitted. Returned alongside
-     * `would_prorate: false`; this is not an error response.
+     * `would_prorate: false`; this is not an error response. `negative_amount` is retained for backward
+     * compatibility but is no longer returned - a negative-net change now either proceeds with a
+     * Proration Refund (`would_refund: true`), is rejected as `refund_not_possible`, or is rejected as
+     * `refund_disallowed_by_policy` when the applicable proration policy does not allow refunds.
      *
      */
-    rejection_reason: "negative_amount" | "no_change";
+    rejection_reason: "negative_amount" | "no_change" | "refund_not_possible" | "refund_disallowed_by_policy";
     /**
      * The value as a whole number of the currency's smallest subdivision.
      */
@@ -11702,6 +11738,18 @@ type SubscriptionMetaWritable = {
      * A history of price updates that have been applied to this subscription.
      */
     price_update_history?: Array<SubscriptionPriceUpdateHistoryEntry>;
+    /**
+     * The ID of the most recent Proration Refund issued for this subscription, if any.
+     */
+    last_refund_id?: string;
+    /**
+     * The amount of the most recent Proration Refund issued for this subscription, if any.
+     */
+    last_refund_amount?: number;
+    /**
+     * Who or what most recently paused this subscription, while it remains paused. Absent when the subscription has never been paused, or is not currently paused (cleared on resume). Only visible to merchandizer/store or organization-scoped callers.
+     */
+    paused_by?: "subscriber" | "merchandizer" | "dunning";
 };
 type SubscriptionAttributesWritable = {
     external_ref?: ExternalRef;