@shipstatic/ship 3.4.0-beta.5 → 3.4.0-beta.6

package/dist/index.d.cts

@@ -942,12 +942,10 @@ interface Account {
      * from where the account stands. It excludes the plan and cadence the
      * account already holds and the one move the door refuses, a dearer tier
      * at a shorter interval (an immediate move would mint a proration credit,
-     * a deferred one would make a customer asking for more wait a year). A
-     * cheaper tier the account does not yet fit is listed with what stands in
-     * the way ({@link PlanDestination.excess}). The rule's owner is the
-     * platform's plan table; a console feeds these rows into its own move
-     * model instead of restating it. Additive: absent on responses that
-     * predate it, and a client then derives as it did.
+     * a deferred one would make a customer asking for more wait a year). The
+     * rule's owner is the platform's plan table; a console feeds these
+     * intervals into its own move model instead of restating it. Additive:
+     * absent on responses that predate it, and a client then derives as it did.
      */
     readonly destinations?: PlanDestination[];
 }
@@ -959,17 +957,6 @@ interface Account {
 interface PlanDestination {
     readonly plan: AccountPlanType;
     readonly intervals: BillingInterval[];
-    /**
-     * What the account holds beyond what this plan allows: per kind, how many
-     * to remove. Present only on a cheaper tier the account does not fit, and
-     * then never empty. A move down a tier is booked only by an account that
-     * fits it, so the change door refuses the move until the owner has removed
-     * the excess, and the field is gone from the next read. A move already
-     * booked says the same of itself ({@link ScheduledChange.excess}). Which
-     * kinds count is the platform's to decide; a client renders the keys it is
-     * given.
-     */
-    readonly excess?: Partial<Caps>;
 }
 /**
  * Acknowledgement of `DELETE /account` (202). Termination is asynchronous —
@@ -2499,9 +2486,10 @@ interface PlansResponse {
  * Schedule that applies the change at period end. The answer says which
  * happened ({@link PlanChangeResponse}).
  *
- * A move down a tier is refused while the account holds more than the
- * destination allows (400, `details.excess` in {@link PlanDestination.excess}'s
- * shape): it is booked only by an account that fits it.
+ * A move down a tier is booked only by an account that fits it: while the
+ * account holds more members or domains than the destination allows, the
+ * door refuses (400) with a sentence naming what to remove, and the same
+ * counts in `details.excess`, keyed like {@link Caps}.
  */
 interface PlanChangeRequest {
     readonly plan: AccountPlanType;
@@ -2523,20 +2511,6 @@ interface ScheduledChange {
     readonly plan: AccountPlanType;
     readonly interval: BillingInterval;
     readonly at: number;
-    /**
-     * What the account must remove before `at` to fit the booked plan: per
-     * kind, how many, in {@link PlanDestination.excess}'s shape. A move down a
-     * tier is booked by an account that fits it, so this is absent on the day
-     * of booking and on the change door's answer. The account keeps its
-     * current plan until the change applies, though, and may add a member or
-     * a domain the booked plan has no room for; `GET /account` then counts
-     * them here, for as long as the change is booked, whatever else the
-     * account may or may not order meanwhile. It is a count to REMOVE, not of
-     * what pauses: holdings that do not fit when the change applies are
-     * paused by the platform's own rule, which for members pauses every
-     * member while the account is over. Absent while the account fits.
-     */
-    readonly excess?: Partial<Caps>;
 }
 /**
  * The answer of `POST /billing/change` — exactly one field is set, and the

package/dist/index.d.ts

@@ -942,12 +942,10 @@ interface Account {
      * from where the account stands. It excludes the plan and cadence the
      * account already holds and the one move the door refuses, a dearer tier
      * at a shorter interval (an immediate move would mint a proration credit,
-     * a deferred one would make a customer asking for more wait a year). A
-     * cheaper tier the account does not yet fit is listed with what stands in
-     * the way ({@link PlanDestination.excess}). The rule's owner is the
-     * platform's plan table; a console feeds these rows into its own move
-     * model instead of restating it. Additive: absent on responses that
-     * predate it, and a client then derives as it did.
+     * a deferred one would make a customer asking for more wait a year). The
+     * rule's owner is the platform's plan table; a console feeds these
+     * intervals into its own move model instead of restating it. Additive:
+     * absent on responses that predate it, and a client then derives as it did.
      */
     readonly destinations?: PlanDestination[];
 }
@@ -959,17 +957,6 @@ interface Account {
 interface PlanDestination {
     readonly plan: AccountPlanType;
     readonly intervals: BillingInterval[];
-    /**
-     * What the account holds beyond what this plan allows: per kind, how many
-     * to remove. Present only on a cheaper tier the account does not fit, and
-     * then never empty. A move down a tier is booked only by an account that
-     * fits it, so the change door refuses the move until the owner has removed
-     * the excess, and the field is gone from the next read. A move already
-     * booked says the same of itself ({@link ScheduledChange.excess}). Which
-     * kinds count is the platform's to decide; a client renders the keys it is
-     * given.
-     */
-    readonly excess?: Partial<Caps>;
 }
 /**
  * Acknowledgement of `DELETE /account` (202). Termination is asynchronous —
@@ -2499,9 +2486,10 @@ interface PlansResponse {
  * Schedule that applies the change at period end. The answer says which
  * happened ({@link PlanChangeResponse}).
  *
- * A move down a tier is refused while the account holds more than the
- * destination allows (400, `details.excess` in {@link PlanDestination.excess}'s
- * shape): it is booked only by an account that fits it.
+ * A move down a tier is booked only by an account that fits it: while the
+ * account holds more members or domains than the destination allows, the
+ * door refuses (400) with a sentence naming what to remove, and the same
+ * counts in `details.excess`, keyed like {@link Caps}.
  */
 interface PlanChangeRequest {
     readonly plan: AccountPlanType;
@@ -2523,20 +2511,6 @@ interface ScheduledChange {
     readonly plan: AccountPlanType;
     readonly interval: BillingInterval;
     readonly at: number;
-    /**
-     * What the account must remove before `at` to fit the booked plan: per
-     * kind, how many, in {@link PlanDestination.excess}'s shape. A move down a
-     * tier is booked by an account that fits it, so this is absent on the day
-     * of booking and on the change door's answer. The account keeps its
-     * current plan until the change applies, though, and may add a member or
-     * a domain the booked plan has no room for; `GET /account` then counts
-     * them here, for as long as the change is booked, whatever else the
-     * account may or may not order meanwhile. It is a count to REMOVE, not of
-     * what pauses: holdings that do not fit when the change applies are
-     * paused by the platform's own rule, which for members pauses every
-     * member while the account is over. Absent while the account fits.
-     */
-    readonly excess?: Partial<Caps>;
 }
 /**
  * The answer of `POST /billing/change` — exactly one field is set, and the