@shipstatic/types 2.17.0-beta.8 → 2.17.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/index.d.ts +33 -7
- package/package.json +1 -1
- package/src/index.ts +33 -7
package/dist/index.d.ts
CHANGED
|
@@ -1853,6 +1853,20 @@ export interface Plan {
|
|
|
1853
1853
|
* nothing (a plan sold by conversation publishes no numbers).
|
|
1854
1854
|
*/
|
|
1855
1855
|
readonly caps: Caps | null;
|
|
1856
|
+
/**
|
|
1857
|
+
* Why this row cannot be ordered right now — the closed door's own sentence,
|
|
1858
|
+
* verbatim — or absent when the way is open. A menu lists what can be
|
|
1859
|
+
* ordered, and a row that is sold but not yet orderable (its door is closed:
|
|
1860
|
+
* checkout unbuilt, a feature unfinished) SAYS SO on the menu instead of
|
|
1861
|
+
* only at the order.
|
|
1862
|
+
*
|
|
1863
|
+
* Clients branch on PRESENCE and render the sentence unchanged — they know
|
|
1864
|
+
* *that* the row is closed, never *which* door or *when it lifts*; the
|
|
1865
|
+
* vocabulary of doors stays server-side. The same rule the refusal follows:
|
|
1866
|
+
* `POST /billing/change` onto a closed row answers 400 with
|
|
1867
|
+
* `details.closed`, and its `message` is this sentence.
|
|
1868
|
+
*/
|
|
1869
|
+
readonly closed?: string;
|
|
1856
1870
|
}
|
|
1857
1871
|
/**
|
|
1858
1872
|
* Response for `GET /plans` — the whole public menu, in display order.
|
|
@@ -1885,10 +1899,16 @@ export interface PlanChangeRequest {
|
|
|
1885
1899
|
readonly interval: BillingInterval;
|
|
1886
1900
|
}
|
|
1887
1901
|
/**
|
|
1888
|
-
* The pending plan change — a Stripe Subscription Schedule the
|
|
1889
|
-
*
|
|
1890
|
-
*
|
|
1891
|
-
*
|
|
1902
|
+
* The pending plan change — a Stripe Subscription Schedule, mirrored onto the
|
|
1903
|
+
* account. `at` is when it applies (the current period's end, Unix seconds).
|
|
1904
|
+
*
|
|
1905
|
+
* WHO minted the schedule is deliberately not part of this shape, and both
|
|
1906
|
+
* kinds mirror here identically: Stripe mints one when a customer confirms a
|
|
1907
|
+
* cadence downgrade on its own hosted page, and the platform mints one for a
|
|
1908
|
+
* cheaper TIER, the single move Stripe's Customer Portal cannot express.
|
|
1909
|
+
*
|
|
1910
|
+
* Reversible until it applies, and `DELETE /billing/change` is the only way:
|
|
1911
|
+
* Stripe's Portal displays a pending change but offers no control to undo it.
|
|
1892
1912
|
*/
|
|
1893
1913
|
export interface ScheduledChange {
|
|
1894
1914
|
readonly plan: AccountPlanType;
|
|
@@ -1901,9 +1921,15 @@ export interface ScheduledChange {
|
|
|
1901
1921
|
* compile, so "which door was taken" is structural rather than prose.
|
|
1902
1922
|
*
|
|
1903
1923
|
* `url` means GO: a Stripe page (Checkout, or the Portal's confirmation page)
|
|
1904
|
-
* finishes the change and the browser must be redirected to it. `
|
|
1905
|
-
*
|
|
1906
|
-
* the
|
|
1924
|
+
* finishes the change and the browser must be redirected to it. A `url` does
|
|
1925
|
+
* NOT imply money moves — on the confirmation page Stripe decides whether to
|
|
1926
|
+
* charge now or defer the change to period end, and says which. `scheduled`
|
|
1927
|
+
* means DONE: the change is booked for period end by the platform itself,
|
|
1928
|
+
* nothing to visit, and the account's `scheduled` field now carries it.
|
|
1929
|
+
*
|
|
1930
|
+
* A client branches on the SHAPE and holds no copy of which move takes which
|
|
1931
|
+
* door — which is what let the server move that boundary without a wire
|
|
1932
|
+
* change (2026-08-25).
|
|
1907
1933
|
*/
|
|
1908
1934
|
export type PlanChangeResponse =
|
|
1909
1935
|
/** GO: a Stripe page finishes the change. Absolute URL, single use, short-lived. */
|
package/package.json
CHANGED
package/src/index.ts
CHANGED
|
@@ -2714,6 +2714,20 @@ export interface Plan {
|
|
|
2714
2714
|
* nothing (a plan sold by conversation publishes no numbers).
|
|
2715
2715
|
*/
|
|
2716
2716
|
readonly caps: Caps | null;
|
|
2717
|
+
/**
|
|
2718
|
+
* Why this row cannot be ordered right now — the closed door's own sentence,
|
|
2719
|
+
* verbatim — or absent when the way is open. A menu lists what can be
|
|
2720
|
+
* ordered, and a row that is sold but not yet orderable (its door is closed:
|
|
2721
|
+
* checkout unbuilt, a feature unfinished) SAYS SO on the menu instead of
|
|
2722
|
+
* only at the order.
|
|
2723
|
+
*
|
|
2724
|
+
* Clients branch on PRESENCE and render the sentence unchanged — they know
|
|
2725
|
+
* *that* the row is closed, never *which* door or *when it lifts*; the
|
|
2726
|
+
* vocabulary of doors stays server-side. The same rule the refusal follows:
|
|
2727
|
+
* `POST /billing/change` onto a closed row answers 400 with
|
|
2728
|
+
* `details.closed`, and its `message` is this sentence.
|
|
2729
|
+
*/
|
|
2730
|
+
readonly closed?: string;
|
|
2717
2731
|
}
|
|
2718
2732
|
|
|
2719
2733
|
/**
|
|
@@ -2749,10 +2763,16 @@ export interface PlanChangeRequest {
|
|
|
2749
2763
|
}
|
|
2750
2764
|
|
|
2751
2765
|
/**
|
|
2752
|
-
* The pending plan change — a Stripe Subscription Schedule the
|
|
2753
|
-
*
|
|
2754
|
-
*
|
|
2755
|
-
*
|
|
2766
|
+
* The pending plan change — a Stripe Subscription Schedule, mirrored onto the
|
|
2767
|
+
* account. `at` is when it applies (the current period's end, Unix seconds).
|
|
2768
|
+
*
|
|
2769
|
+
* WHO minted the schedule is deliberately not part of this shape, and both
|
|
2770
|
+
* kinds mirror here identically: Stripe mints one when a customer confirms a
|
|
2771
|
+
* cadence downgrade on its own hosted page, and the platform mints one for a
|
|
2772
|
+
* cheaper TIER, the single move Stripe's Customer Portal cannot express.
|
|
2773
|
+
*
|
|
2774
|
+
* Reversible until it applies, and `DELETE /billing/change` is the only way:
|
|
2775
|
+
* Stripe's Portal displays a pending change but offers no control to undo it.
|
|
2756
2776
|
*/
|
|
2757
2777
|
export interface ScheduledChange {
|
|
2758
2778
|
readonly plan: AccountPlanType;
|
|
@@ -2766,9 +2786,15 @@ export interface ScheduledChange {
|
|
|
2766
2786
|
* compile, so "which door was taken" is structural rather than prose.
|
|
2767
2787
|
*
|
|
2768
2788
|
* `url` means GO: a Stripe page (Checkout, or the Portal's confirmation page)
|
|
2769
|
-
* finishes the change and the browser must be redirected to it. `
|
|
2770
|
-
*
|
|
2771
|
-
* the
|
|
2789
|
+
* finishes the change and the browser must be redirected to it. A `url` does
|
|
2790
|
+
* NOT imply money moves — on the confirmation page Stripe decides whether to
|
|
2791
|
+
* charge now or defer the change to period end, and says which. `scheduled`
|
|
2792
|
+
* means DONE: the change is booked for period end by the platform itself,
|
|
2793
|
+
* nothing to visit, and the account's `scheduled` field now carries it.
|
|
2794
|
+
*
|
|
2795
|
+
* A client branches on the SHAPE and holds no copy of which move takes which
|
|
2796
|
+
* door — which is what let the server move that boundary without a wire
|
|
2797
|
+
* change (2026-08-25).
|
|
2772
2798
|
*/
|
|
2773
2799
|
export type PlanChangeResponse =
|
|
2774
2800
|
/** GO: a Stripe page finishes the change. Absolute URL, single use, short-lived. */
|