@aifeatures/backend 0.5.5 → 0.6.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.cjs +5 -5
- package/dist/index.d.cts +1710 -9
- package/dist/index.d.ts +1710 -9
- package/dist/index.js +5 -5
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -773,6 +773,10 @@ type CreateTestOrder = {
|
|
|
773
773
|
[key: string]: string;
|
|
774
774
|
};
|
|
775
775
|
shipping_address?: TestShippingAddress;
|
|
776
|
+
/**
|
|
777
|
+
* The postage option to record, by LABEL — the same identity the real cart checkout matches on. Omit and the FIRST configured rate is recorded, which is what Stripe preselects when a real checkout sends the whole list. The site's free-shipping threshold is applied exactly as the real checkout applies it (the cheapest rate is zeroed, never removed), so the rehearsal's postage is the postage. A label the store does not offer is a 400 — never a substituted rate. Ignored when nothing in the order ships.
|
|
778
|
+
*/
|
|
779
|
+
shipping_option?: string;
|
|
776
780
|
};
|
|
777
781
|
type TestSubscriptionResult = {
|
|
778
782
|
order_id: string;
|
|
@@ -825,6 +829,10 @@ type CreateMultiItemTestOrder = {
|
|
|
825
829
|
[key: string]: string;
|
|
826
830
|
};
|
|
827
831
|
shipping_address?: TestShippingAddress;
|
|
832
|
+
/**
|
|
833
|
+
* The postage option to record, by LABEL — the same identity the real cart checkout matches on. Omit and the FIRST configured rate is recorded, which is what Stripe preselects when a real checkout sends the whole list. The site's free-shipping threshold is applied exactly as the real checkout applies it (the cheapest rate is zeroed, never removed), so the rehearsal's postage is the postage. A label the store does not offer is a 400 — never a substituted rate. Ignored when nothing in the order ships.
|
|
834
|
+
*/
|
|
835
|
+
shipping_option?: string;
|
|
828
836
|
};
|
|
829
837
|
type CreateVariant = {
|
|
830
838
|
title?: string | null;
|
|
@@ -1031,6 +1039,9 @@ type Order = {
|
|
|
1031
1039
|
*/
|
|
1032
1040
|
order_number: number | null;
|
|
1033
1041
|
site_id: string;
|
|
1042
|
+
/**
|
|
1043
|
+
* Where the order came from: `checkout` (a Stripe Checkout session), `subscription` (a renewal cycle of a subscription plan), or `invoice` (an invoice sent from the store — a one-off invoice or a retainer cycle). Invoice orders are managed through the invoice endpoints, are excluded from `GET /orders` unless `source` asks for them, and refuse the generic order mutations (resend-receipt, reset-downloads, fulfillment).
|
|
1044
|
+
*/
|
|
1034
1045
|
source: string;
|
|
1035
1046
|
/**
|
|
1036
1047
|
* Simulated owner-initiated purchase — full pipeline, no Stripe, no money. Badged in dashboards; refunds are simulated too.
|
|
@@ -1039,7 +1050,7 @@ type Order = {
|
|
|
1039
1050
|
/**
|
|
1040
1051
|
* Where the order sits in its money lifecycle. The refund arms derive from the CHARGED total, postage included: `refunded` once amount_refunded >= amount_total + (shipping_total ?? 0), `partially_refunded` while some of it is still outstanding. Comparing against amount_total alone (line values, no postage) marks a shipped order fully refunded while the buyer is still owed the postage. NOT the download-entitlement test — that keys on goods (see download_url), so an order whose every good was refunded but whose postage the merchant kept sits at `partially_refunded` with the download already cut.
|
|
1041
1052
|
*/
|
|
1042
|
-
status: "pending" | "paid" | "failed" | "expired" | "refunded" | "partially_refunded" | "disputed";
|
|
1053
|
+
status: "pending" | "paid" | "failed" | "expired" | "refunded" | "partially_refunded" | "disputed" | "voided";
|
|
1043
1054
|
stripe_checkout_session_id: string | null;
|
|
1044
1055
|
stripe_payment_intent_id: string | null;
|
|
1045
1056
|
/**
|
|
@@ -1154,7 +1165,7 @@ type OrdersList = {
|
|
|
1154
1165
|
offset: number;
|
|
1155
1166
|
};
|
|
1156
1167
|
type RefundResult = {
|
|
1157
|
-
status: "pending" | "paid" | "failed" | "expired" | "refunded" | "partially_refunded" | "disputed";
|
|
1168
|
+
status: "pending" | "paid" | "failed" | "expired" | "refunded" | "partially_refunded" | "disputed" | "voided";
|
|
1158
1169
|
/**
|
|
1159
1170
|
* Cumulative refunded total in minor units as persisted on the order after this refund.
|
|
1160
1171
|
*/
|
|
@@ -1167,6 +1178,10 @@ type RefundResult = {
|
|
|
1167
1178
|
* How much of `amount_refunded` is tax, as persisted after this refund (minor units) — the tax twin of shipping_refunded. Itemized refunds on exclusive automatic-tax orders add the selection's proportional tax to the refund automatically; `full: true` returns everything outstanding, tax included.
|
|
1168
1179
|
*/
|
|
1169
1180
|
tax_refunded: number;
|
|
1181
|
+
/**
|
|
1182
|
+
* Invoice orders only: the Stripe credit note that mirrors this refund on the invoice. Null when the note could not be created in this request — the row is kept and the sweeper retries; GET /invoices/{id} lists every note under `credit_notes`.
|
|
1183
|
+
*/
|
|
1184
|
+
credit_note_id?: string | null;
|
|
1170
1185
|
};
|
|
1171
1186
|
type RefundOrder = {
|
|
1172
1187
|
/**
|
|
@@ -1213,6 +1228,16 @@ type Customer = {
|
|
|
1213
1228
|
};
|
|
1214
1229
|
created_at: string;
|
|
1215
1230
|
updated_at: string;
|
|
1231
|
+
/**
|
|
1232
|
+
* Remembered language for this customer's invoices and receipts
|
|
1233
|
+
*/
|
|
1234
|
+
locale?: string | null;
|
|
1235
|
+
/**
|
|
1236
|
+
* Remembered bill-to identity (company, name, address, tax id, PO)
|
|
1237
|
+
*/
|
|
1238
|
+
bill_to?: {
|
|
1239
|
+
[key: string]: unknown;
|
|
1240
|
+
} | null;
|
|
1216
1241
|
};
|
|
1217
1242
|
type CustomersList = {
|
|
1218
1243
|
customers: Array<Customer>;
|
|
@@ -1597,6 +1622,543 @@ type CreatePreviewSession = {
|
|
|
1597
1622
|
*/
|
|
1598
1623
|
email: string;
|
|
1599
1624
|
};
|
|
1625
|
+
type InvoiceLineItem = {
|
|
1626
|
+
description: string;
|
|
1627
|
+
quantity: number;
|
|
1628
|
+
/**
|
|
1629
|
+
* Line total in minor units
|
|
1630
|
+
*/
|
|
1631
|
+
amount: number;
|
|
1632
|
+
};
|
|
1633
|
+
type InvoiceBillTo = {
|
|
1634
|
+
company?: string | null;
|
|
1635
|
+
name?: string | null;
|
|
1636
|
+
address?: {
|
|
1637
|
+
line1?: string | null;
|
|
1638
|
+
line2?: string | null;
|
|
1639
|
+
city?: string | null;
|
|
1640
|
+
state?: string | null;
|
|
1641
|
+
postal_code?: string | null;
|
|
1642
|
+
/**
|
|
1643
|
+
* Two-letter ISO code
|
|
1644
|
+
*/
|
|
1645
|
+
country?: string | null;
|
|
1646
|
+
} | null;
|
|
1647
|
+
tax_id?: {
|
|
1648
|
+
type: string;
|
|
1649
|
+
value: string;
|
|
1650
|
+
} | null;
|
|
1651
|
+
po_number?: string | null;
|
|
1652
|
+
service_period?: string | null;
|
|
1653
|
+
} | null;
|
|
1654
|
+
type Invoice = {
|
|
1655
|
+
id: string;
|
|
1656
|
+
/**
|
|
1657
|
+
* Stripe's invoice number on the merchant's account — what the buyer sees
|
|
1658
|
+
*/
|
|
1659
|
+
invoice_number: string | null;
|
|
1660
|
+
status: "pending" | "paid" | "failed" | "expired" | "refunded" | "partially_refunded" | "disputed" | "voided";
|
|
1661
|
+
/**
|
|
1662
|
+
* Derived state for display: where the invoice stands right now
|
|
1663
|
+
*/
|
|
1664
|
+
label: "creating" | "failed" | "awaiting_payment" | "overdue" | "payment_processing" | "awaiting_authentication" | "paid" | "paid_outside_stripe" | "paid_by_credit" | "partially_refunded" | "refunded" | "disputed" | "voided" | "uncollectible";
|
|
1665
|
+
days_overdue: number | null;
|
|
1666
|
+
customer_id: string | null;
|
|
1667
|
+
customer_email: string | null;
|
|
1668
|
+
customer_name: string | null;
|
|
1669
|
+
currency: string;
|
|
1670
|
+
/**
|
|
1671
|
+
* Sum of the lines, minor units
|
|
1672
|
+
*/
|
|
1673
|
+
amount_subtotal: number;
|
|
1674
|
+
tax_total: number;
|
|
1675
|
+
/**
|
|
1676
|
+
* Whether the recorded tax is included in the prices or charged on top
|
|
1677
|
+
*/
|
|
1678
|
+
tax_behavior: "inclusive" | "exclusive";
|
|
1679
|
+
/**
|
|
1680
|
+
* Discount already reflected in amount_total, in minor currency units
|
|
1681
|
+
*/
|
|
1682
|
+
discount_total: number;
|
|
1683
|
+
/**
|
|
1684
|
+
* The charged total — subtotal less discounts, plus tax when tax is added on top
|
|
1685
|
+
*/
|
|
1686
|
+
amount_total: number;
|
|
1687
|
+
credit_applied: number;
|
|
1688
|
+
amount_due: number | null;
|
|
1689
|
+
amount_paid: number | null;
|
|
1690
|
+
amount_paid_off_stripe: number;
|
|
1691
|
+
amount_refunded: number;
|
|
1692
|
+
line_items: Array<InvoiceLineItem>;
|
|
1693
|
+
note: string | null;
|
|
1694
|
+
footer: string | null;
|
|
1695
|
+
bill_to: InvoiceBillTo;
|
|
1696
|
+
locale: string | null;
|
|
1697
|
+
due_at: string | null;
|
|
1698
|
+
created_at: string;
|
|
1699
|
+
paid_at: string | null;
|
|
1700
|
+
/**
|
|
1701
|
+
* none | processing | requires_action | failed
|
|
1702
|
+
*/
|
|
1703
|
+
payment_state: string;
|
|
1704
|
+
payment_method: string | null;
|
|
1705
|
+
paid_out_of_band: boolean;
|
|
1706
|
+
paid_by_credit: boolean;
|
|
1707
|
+
marked_uncollectible_at: string | null;
|
|
1708
|
+
reminders: {
|
|
1709
|
+
schedule: Array<number>;
|
|
1710
|
+
disabled: boolean;
|
|
1711
|
+
count: number;
|
|
1712
|
+
next_at: string | null;
|
|
1713
|
+
paused_until: string | null;
|
|
1714
|
+
final_sent_at: string | null;
|
|
1715
|
+
};
|
|
1716
|
+
/**
|
|
1717
|
+
* The latest invoice/reminder send to the current recipient: queued | sending | sent | delivered | bounced | complained | failed | unknown
|
|
1718
|
+
*/
|
|
1719
|
+
delivery: {
|
|
1720
|
+
state: string;
|
|
1721
|
+
at: string | null;
|
|
1722
|
+
recipient: string;
|
|
1723
|
+
kind: string;
|
|
1724
|
+
} | null;
|
|
1725
|
+
/**
|
|
1726
|
+
* The /v1/i/{token} link — the only link the buyer is ever sent
|
|
1727
|
+
*/
|
|
1728
|
+
pay_url: string | null;
|
|
1729
|
+
pdf_url: string | null;
|
|
1730
|
+
payment_methods: Array<"card" | "bank" | "link"> | null;
|
|
1731
|
+
replaces_order_id: string | null;
|
|
1732
|
+
replaced_by_order_id: string | null;
|
|
1733
|
+
correction_reason: string | null;
|
|
1734
|
+
retainer_id: string | null;
|
|
1735
|
+
/**
|
|
1736
|
+
* Automatic invoices are managed in Stripe; this app does not send their payment requests.
|
|
1737
|
+
*/
|
|
1738
|
+
collection_method: "send_invoice" | "charge_automatically";
|
|
1739
|
+
operation: {
|
|
1740
|
+
step: string;
|
|
1741
|
+
last_error: string | null;
|
|
1742
|
+
attempts: number;
|
|
1743
|
+
} | null;
|
|
1744
|
+
stripe_invoice_id: string | null;
|
|
1745
|
+
/**
|
|
1746
|
+
* Every refund on this invoice and the Stripe credit note that mirrors it — the refund/credit state a merchant sees
|
|
1747
|
+
*/
|
|
1748
|
+
credit_notes: Array<{
|
|
1749
|
+
id: string;
|
|
1750
|
+
/**
|
|
1751
|
+
* Null while the credit note is still being created (the sweeper retries)
|
|
1752
|
+
*/
|
|
1753
|
+
stripe_credit_note_id: string | null;
|
|
1754
|
+
stripe_refund_id: string;
|
|
1755
|
+
amount: number;
|
|
1756
|
+
currency: string;
|
|
1757
|
+
origin: "api" | "dashboard";
|
|
1758
|
+
created_at: string;
|
|
1759
|
+
}>;
|
|
1760
|
+
/**
|
|
1761
|
+
* GET /invoices/{id} only: every buyer-facing send (invoice, reminders, void notice, receipt) oldest first, with its delivery state
|
|
1762
|
+
*/
|
|
1763
|
+
communications?: Array<{
|
|
1764
|
+
id: string;
|
|
1765
|
+
kind: string;
|
|
1766
|
+
slot: number | null;
|
|
1767
|
+
recipient: string;
|
|
1768
|
+
state: string;
|
|
1769
|
+
state_at: string | null;
|
|
1770
|
+
error: string | null;
|
|
1771
|
+
created_at: string;
|
|
1772
|
+
}>;
|
|
1773
|
+
};
|
|
1774
|
+
type CreateInvoiceResult = {
|
|
1775
|
+
status: "created" | "in_progress";
|
|
1776
|
+
invoice?: Invoice;
|
|
1777
|
+
order_id?: string;
|
|
1778
|
+
step?: string;
|
|
1779
|
+
email_queued?: boolean;
|
|
1780
|
+
};
|
|
1781
|
+
type InvoiceError = {
|
|
1782
|
+
error: string;
|
|
1783
|
+
code?: string;
|
|
1784
|
+
existing?: {
|
|
1785
|
+
order_id: string;
|
|
1786
|
+
invoice_number: string | null;
|
|
1787
|
+
created_at: string;
|
|
1788
|
+
};
|
|
1789
|
+
order_id?: string;
|
|
1790
|
+
};
|
|
1791
|
+
type CreateInvoiceLine = {
|
|
1792
|
+
description: string;
|
|
1793
|
+
/**
|
|
1794
|
+
* Decimal quantities are folded into one line ('2.5 hours × US$100.00')
|
|
1795
|
+
*/
|
|
1796
|
+
quantity?: number | string;
|
|
1797
|
+
/**
|
|
1798
|
+
* Minor units per unit
|
|
1799
|
+
*/
|
|
1800
|
+
unit_amount: number;
|
|
1801
|
+
};
|
|
1802
|
+
type CreateInvoice = {
|
|
1803
|
+
/**
|
|
1804
|
+
* The site the invoice is sent from (organization API key)
|
|
1805
|
+
*/
|
|
1806
|
+
site_id: string;
|
|
1807
|
+
customer_email: string;
|
|
1808
|
+
customer_name?: string | null;
|
|
1809
|
+
bill_to?: InvoiceBillTo;
|
|
1810
|
+
line_items: Array<CreateInvoiceLine>;
|
|
1811
|
+
/**
|
|
1812
|
+
* Per-invoice memo — no phone numbers, links or email addresses
|
|
1813
|
+
*/
|
|
1814
|
+
note?: string | null;
|
|
1815
|
+
/**
|
|
1816
|
+
* Days until due (0 = on receipt); default = the site setting
|
|
1817
|
+
*/
|
|
1818
|
+
due_days?: number | null;
|
|
1819
|
+
/**
|
|
1820
|
+
* YYYY-MM-DD in the site timezone; alternative to due_days
|
|
1821
|
+
*/
|
|
1822
|
+
due_date?: string | null;
|
|
1823
|
+
/**
|
|
1824
|
+
* Day offsets from the due date (negative = before); false = none; absent = the site default
|
|
1825
|
+
*/
|
|
1826
|
+
reminders?: Array<number> | false | null;
|
|
1827
|
+
/**
|
|
1828
|
+
* Buyer language for the email and Stripe's page; remembered for the customer
|
|
1829
|
+
*/
|
|
1830
|
+
locale?: string | null;
|
|
1831
|
+
/**
|
|
1832
|
+
* Send even if the same recipient got an invoice for the same amount in the last 24 hours
|
|
1833
|
+
*/
|
|
1834
|
+
allow_duplicate?: boolean;
|
|
1835
|
+
/**
|
|
1836
|
+
* Caller-supplied; a repeat with the same key and payload returns the original invoice, a different payload is refused
|
|
1837
|
+
*/
|
|
1838
|
+
idempotency_key: string;
|
|
1839
|
+
};
|
|
1840
|
+
type InvoiceAggregates = {
|
|
1841
|
+
currency: string;
|
|
1842
|
+
outstanding: {
|
|
1843
|
+
amount: number;
|
|
1844
|
+
count: number;
|
|
1845
|
+
};
|
|
1846
|
+
overdue: {
|
|
1847
|
+
amount: number;
|
|
1848
|
+
count: number;
|
|
1849
|
+
};
|
|
1850
|
+
paid_this_month: {
|
|
1851
|
+
amount: number;
|
|
1852
|
+
count: number;
|
|
1853
|
+
};
|
|
1854
|
+
};
|
|
1855
|
+
type InvoicesList = {
|
|
1856
|
+
invoices: Array<Invoice>;
|
|
1857
|
+
total: number;
|
|
1858
|
+
limit: number;
|
|
1859
|
+
offset: number;
|
|
1860
|
+
aggregates?: InvoiceAggregates;
|
|
1861
|
+
};
|
|
1862
|
+
type InvoicePreview = {
|
|
1863
|
+
subject: string;
|
|
1864
|
+
html: string;
|
|
1865
|
+
text: string;
|
|
1866
|
+
from: string;
|
|
1867
|
+
reply_to: string | null;
|
|
1868
|
+
};
|
|
1869
|
+
type PreviewInvoice = {
|
|
1870
|
+
customer_email: string;
|
|
1871
|
+
customer_name?: string | null;
|
|
1872
|
+
bill_to?: InvoiceBillTo;
|
|
1873
|
+
line_items: Array<CreateInvoiceLine>;
|
|
1874
|
+
/**
|
|
1875
|
+
* Per-invoice memo — no phone numbers, links or email addresses
|
|
1876
|
+
*/
|
|
1877
|
+
note?: string | null;
|
|
1878
|
+
/**
|
|
1879
|
+
* Days until due (0 = on receipt); default = the site setting
|
|
1880
|
+
*/
|
|
1881
|
+
due_days?: number | null;
|
|
1882
|
+
/**
|
|
1883
|
+
* YYYY-MM-DD in the site timezone; alternative to due_days
|
|
1884
|
+
*/
|
|
1885
|
+
due_date?: string | null;
|
|
1886
|
+
/**
|
|
1887
|
+
* Day offsets from the due date (negative = before); false = none; absent = the site default
|
|
1888
|
+
*/
|
|
1889
|
+
reminders?: Array<number> | false | null;
|
|
1890
|
+
/**
|
|
1891
|
+
* Buyer language for the email and Stripe's page; remembered for the customer
|
|
1892
|
+
*/
|
|
1893
|
+
locale?: string | null;
|
|
1894
|
+
};
|
|
1895
|
+
type ReissueResult = {
|
|
1896
|
+
status: "created" | "in_progress" | "failed";
|
|
1897
|
+
invoice?: Invoice;
|
|
1898
|
+
order_id?: string;
|
|
1899
|
+
step?: string;
|
|
1900
|
+
email_queued?: boolean;
|
|
1901
|
+
error?: string;
|
|
1902
|
+
code?: string;
|
|
1903
|
+
} | null;
|
|
1904
|
+
type VoidInvoiceResult = {
|
|
1905
|
+
invoice: Invoice;
|
|
1906
|
+
reissued: ReissueResult;
|
|
1907
|
+
};
|
|
1908
|
+
type VoidInvoice = {
|
|
1909
|
+
site_id: string;
|
|
1910
|
+
reason?: string | null;
|
|
1911
|
+
/**
|
|
1912
|
+
* Void and immediately send a corrected invoice; the two are linked
|
|
1913
|
+
*/
|
|
1914
|
+
reissue_as?: {
|
|
1915
|
+
customer_email: string;
|
|
1916
|
+
customer_name?: string | null;
|
|
1917
|
+
bill_to?: InvoiceBillTo;
|
|
1918
|
+
line_items: Array<CreateInvoiceLine>;
|
|
1919
|
+
/**
|
|
1920
|
+
* Per-invoice memo — no phone numbers, links or email addresses
|
|
1921
|
+
*/
|
|
1922
|
+
note?: string | null;
|
|
1923
|
+
/**
|
|
1924
|
+
* Days until due (0 = on receipt); default = the site setting
|
|
1925
|
+
*/
|
|
1926
|
+
due_days?: number | null;
|
|
1927
|
+
/**
|
|
1928
|
+
* YYYY-MM-DD in the site timezone; alternative to due_days
|
|
1929
|
+
*/
|
|
1930
|
+
due_date?: string | null;
|
|
1931
|
+
/**
|
|
1932
|
+
* Day offsets from the due date (negative = before); false = none; absent = the site default
|
|
1933
|
+
*/
|
|
1934
|
+
reminders?: Array<number> | false | null;
|
|
1935
|
+
/**
|
|
1936
|
+
* Buyer language for the email and Stripe's page; remembered for the customer
|
|
1937
|
+
*/
|
|
1938
|
+
locale?: string | null;
|
|
1939
|
+
/**
|
|
1940
|
+
* Send even if the same recipient got an invoice for the same amount in the last 24 hours
|
|
1941
|
+
*/
|
|
1942
|
+
allow_duplicate?: boolean;
|
|
1943
|
+
/**
|
|
1944
|
+
* Caller-supplied; a repeat with the same key and payload returns the original invoice, a different payload is refused
|
|
1945
|
+
*/
|
|
1946
|
+
idempotency_key: string;
|
|
1947
|
+
} | null;
|
|
1948
|
+
};
|
|
1949
|
+
type RemindInvoiceResult = {
|
|
1950
|
+
invoice: Invoice;
|
|
1951
|
+
communication_id: string | null;
|
|
1952
|
+
};
|
|
1953
|
+
type RecipientCooldownError = {
|
|
1954
|
+
error: string;
|
|
1955
|
+
code: "recipient_cooldown";
|
|
1956
|
+
retry_after_seconds: number;
|
|
1957
|
+
};
|
|
1958
|
+
type InvoiceSiteBody = {
|
|
1959
|
+
site_id: string;
|
|
1960
|
+
};
|
|
1961
|
+
type SnoozeInvoice = {
|
|
1962
|
+
site_id: string;
|
|
1963
|
+
/**
|
|
1964
|
+
* YYYY-MM-DD in the site timezone, or an ISO datetime
|
|
1965
|
+
*/
|
|
1966
|
+
until?: string | null;
|
|
1967
|
+
days?: number | null;
|
|
1968
|
+
};
|
|
1969
|
+
type SetInvoiceReminders = {
|
|
1970
|
+
site_id: string;
|
|
1971
|
+
enabled: boolean;
|
|
1972
|
+
schedule?: Array<number> | null;
|
|
1973
|
+
};
|
|
1974
|
+
type MarkInvoicePaidResult = {
|
|
1975
|
+
invoice: Invoice;
|
|
1976
|
+
classification: string;
|
|
1977
|
+
};
|
|
1978
|
+
type MarkInvoicePaid = {
|
|
1979
|
+
site_id: string;
|
|
1980
|
+
/**
|
|
1981
|
+
* How it was paid: cheque, bank transfer, cash …
|
|
1982
|
+
*/
|
|
1983
|
+
method: string;
|
|
1984
|
+
paid_on?: string | null;
|
|
1985
|
+
reference?: string | null;
|
|
1986
|
+
};
|
|
1987
|
+
type UpdateRecipientResult = {
|
|
1988
|
+
invoice: Invoice;
|
|
1989
|
+
/**
|
|
1990
|
+
* The queued resend; null when no email went out (resend false, invoicing closed, or a payment settling)
|
|
1991
|
+
*/
|
|
1992
|
+
communication_id: string | null;
|
|
1993
|
+
/**
|
|
1994
|
+
* Whether the customer record's email actually changed (false when also_update_customer was off or the address belongs to another customer)
|
|
1995
|
+
*/
|
|
1996
|
+
customer_updated: boolean;
|
|
1997
|
+
};
|
|
1998
|
+
type UpdateInvoiceRecipient = {
|
|
1999
|
+
site_id: string;
|
|
2000
|
+
email: string;
|
|
2001
|
+
also_update_customer?: boolean;
|
|
2002
|
+
/**
|
|
2003
|
+
* Send the invoice email to the new address now (default true)
|
|
2004
|
+
*/
|
|
2005
|
+
resend?: boolean;
|
|
2006
|
+
};
|
|
2007
|
+
type CustomerBilling = {
|
|
2008
|
+
id: string;
|
|
2009
|
+
email: string;
|
|
2010
|
+
name: string | null;
|
|
2011
|
+
locale: string | null;
|
|
2012
|
+
bill_to: {
|
|
2013
|
+
[key: string]: unknown;
|
|
2014
|
+
} | null;
|
|
2015
|
+
stripe_customer_id: string | null;
|
|
2016
|
+
};
|
|
2017
|
+
type UpdateCustomerBilling = {
|
|
2018
|
+
site_id: string;
|
|
2019
|
+
name?: string | null;
|
|
2020
|
+
bill_to?: InvoiceBillTo;
|
|
2021
|
+
locale?: string | null;
|
|
2022
|
+
};
|
|
2023
|
+
type InvoiceSettings = {
|
|
2024
|
+
due_days: number;
|
|
2025
|
+
reminder_schedule: Array<number>;
|
|
2026
|
+
footer: string | null;
|
|
2027
|
+
locale: string | null;
|
|
2028
|
+
timezone: string | null;
|
|
2029
|
+
blocked: {
|
|
2030
|
+
at: string;
|
|
2031
|
+
reason: string | null;
|
|
2032
|
+
} | null;
|
|
2033
|
+
budget: {
|
|
2034
|
+
per_hour: number;
|
|
2035
|
+
per_day: number;
|
|
2036
|
+
};
|
|
2037
|
+
payments_active: boolean;
|
|
2038
|
+
};
|
|
2039
|
+
type UpdateInvoiceSettings = {
|
|
2040
|
+
due_days?: number;
|
|
2041
|
+
reminder_schedule?: Array<number> | false;
|
|
2042
|
+
footer?: string | null;
|
|
2043
|
+
locale?: string | null;
|
|
2044
|
+
timezone?: string | null;
|
|
2045
|
+
};
|
|
2046
|
+
type UpdateSiteInvoicing = {
|
|
2047
|
+
budget_override?: {
|
|
2048
|
+
per_hour: number;
|
|
2049
|
+
per_day: number;
|
|
2050
|
+
} | null;
|
|
2051
|
+
unblock?: boolean;
|
|
2052
|
+
/**
|
|
2053
|
+
* Set to block invoice sending on this site
|
|
2054
|
+
*/
|
|
2055
|
+
block_reason?: string | null;
|
|
2056
|
+
};
|
|
2057
|
+
type Retainer = {
|
|
2058
|
+
id: string;
|
|
2059
|
+
customer_id: string | null;
|
|
2060
|
+
customer_email: string | null;
|
|
2061
|
+
customer_name: string | null;
|
|
2062
|
+
/**
|
|
2063
|
+
* What each cycle bills for — the line the buyer sees
|
|
2064
|
+
*/
|
|
2065
|
+
description: string;
|
|
2066
|
+
/**
|
|
2067
|
+
* Per cycle, minor units (the subtotal; tax per the site's rules)
|
|
2068
|
+
*/
|
|
2069
|
+
amount: number;
|
|
2070
|
+
currency: string;
|
|
2071
|
+
interval: "month" | "year";
|
|
2072
|
+
/**
|
|
2073
|
+
* Day of the month each cycle bills on; null = the creation day
|
|
2074
|
+
*/
|
|
2075
|
+
anchor_day: number | null;
|
|
2076
|
+
days_until_due: number;
|
|
2077
|
+
locale: string | null;
|
|
2078
|
+
bill_to: InvoiceBillTo;
|
|
2079
|
+
status: "creating" | "active" | "paused" | "canceling" | "canceled" | "failed";
|
|
2080
|
+
/**
|
|
2081
|
+
* Every reason the retainer is paused; it resumes only when this is empty
|
|
2082
|
+
*/
|
|
2083
|
+
paused_by: Array<"merchant" | "plan" | "suspension">;
|
|
2084
|
+
skip_next_cycle: boolean;
|
|
2085
|
+
next_cycle_at: string | null;
|
|
2086
|
+
cycles: {
|
|
2087
|
+
count: number;
|
|
2088
|
+
open: number;
|
|
2089
|
+
paid: number;
|
|
2090
|
+
};
|
|
2091
|
+
stripe_subscription_id: string | null;
|
|
2092
|
+
/**
|
|
2093
|
+
* Automatic charging enabled outside this app makes the schedule managed in Stripe.
|
|
2094
|
+
*/
|
|
2095
|
+
collection_method: "send_invoice" | "charge_automatically";
|
|
2096
|
+
created_at: string;
|
|
2097
|
+
canceled_at: string | null;
|
|
2098
|
+
operation: {
|
|
2099
|
+
step: string;
|
|
2100
|
+
last_error: string | null;
|
|
2101
|
+
attempts: number;
|
|
2102
|
+
} | null;
|
|
2103
|
+
};
|
|
2104
|
+
type CreateRetainerResult = {
|
|
2105
|
+
status: "created" | "in_progress";
|
|
2106
|
+
retainer?: Retainer;
|
|
2107
|
+
retainer_id?: string;
|
|
2108
|
+
step?: string;
|
|
2109
|
+
};
|
|
2110
|
+
type RetainerError = {
|
|
2111
|
+
error: string;
|
|
2112
|
+
code?: string;
|
|
2113
|
+
existing?: {
|
|
2114
|
+
retainer_id: string;
|
|
2115
|
+
created_at: string;
|
|
2116
|
+
};
|
|
2117
|
+
retainer_id?: string;
|
|
2118
|
+
};
|
|
2119
|
+
type CreateRetainer = {
|
|
2120
|
+
site_id: string;
|
|
2121
|
+
customer_email: string;
|
|
2122
|
+
customer_name?: string | null;
|
|
2123
|
+
bill_to?: InvoiceBillTo;
|
|
2124
|
+
/**
|
|
2125
|
+
* Printed on every cycle's invoice — no links, phone numbers or email addresses
|
|
2126
|
+
*/
|
|
2127
|
+
description: string;
|
|
2128
|
+
/**
|
|
2129
|
+
* Per cycle, minor units
|
|
2130
|
+
*/
|
|
2131
|
+
amount: number;
|
|
2132
|
+
/**
|
|
2133
|
+
* Default month
|
|
2134
|
+
*/
|
|
2135
|
+
interval?: "month" | "year";
|
|
2136
|
+
/**
|
|
2137
|
+
* Bill on this day of the month (1–28); absent = bill now and every interval from today
|
|
2138
|
+
*/
|
|
2139
|
+
anchor_day?: number | null;
|
|
2140
|
+
days_until_due?: number | null;
|
|
2141
|
+
locale?: string | null;
|
|
2142
|
+
idempotency_key: string;
|
|
2143
|
+
};
|
|
2144
|
+
type RetainersList = {
|
|
2145
|
+
retainers: Array<Retainer>;
|
|
2146
|
+
total: number;
|
|
2147
|
+
limit: number;
|
|
2148
|
+
offset: number;
|
|
2149
|
+
};
|
|
2150
|
+
type UpdateRetainer = {
|
|
2151
|
+
site_id: string;
|
|
2152
|
+
/**
|
|
2153
|
+
* New per-cycle amount, from the NEXT cycle
|
|
2154
|
+
*/
|
|
2155
|
+
amount?: number | null;
|
|
2156
|
+
description?: string | null;
|
|
2157
|
+
days_until_due?: number | null;
|
|
2158
|
+
};
|
|
2159
|
+
type RetainerSiteBody = {
|
|
2160
|
+
site_id: string;
|
|
2161
|
+
};
|
|
1600
2162
|
type Form = {
|
|
1601
2163
|
id: string;
|
|
1602
2164
|
name: string;
|
|
@@ -2328,7 +2890,7 @@ type CartSummaryRequest = {
|
|
|
2328
2890
|
shipping_option?: string;
|
|
2329
2891
|
};
|
|
2330
2892
|
type OrderSessionStatus = {
|
|
2331
|
-
status: "pending" | "paid" | "failed" | "expired" | "refunded" | "partially_refunded" | "disputed";
|
|
2893
|
+
status: "pending" | "paid" | "failed" | "expired" | "refunded" | "partially_refunded" | "disputed" | "voided";
|
|
2332
2894
|
/**
|
|
2333
2895
|
* Human-facing order number ('#1042') — the same one on the buyer's receipt and in the merchant's dashboard. Display only; `order_id` remains the identity. Null when unallocated.
|
|
2334
2896
|
*/
|
|
@@ -2505,9 +3067,13 @@ type AccountMeResult = {
|
|
|
2505
3067
|
order_number: number | null;
|
|
2506
3068
|
status: string;
|
|
2507
3069
|
/**
|
|
2508
|
-
* 'checkout' for a one-time order, 'subscription' for a signup or renewal.
|
|
3070
|
+
* 'checkout' for a one-time order, 'subscription' for a signup or renewal, 'invoice' for an invoice the store sent.
|
|
2509
3071
|
*/
|
|
2510
3072
|
source: string;
|
|
3073
|
+
/**
|
|
3074
|
+
* Invoice rows only: the invoice number the buyer saw on the invoice (order_number is null for them).
|
|
3075
|
+
*/
|
|
3076
|
+
invoice_number: string | null;
|
|
2511
3077
|
amount_total: number;
|
|
2512
3078
|
shipping_total: number | null;
|
|
2513
3079
|
tax_total: number | null;
|
|
@@ -3380,11 +3946,15 @@ type ListOrdersWithSiteTokenData = {
|
|
|
3380
3946
|
/**
|
|
3381
3947
|
* Filter by order status
|
|
3382
3948
|
*/
|
|
3383
|
-
status?: "pending" | "paid" | "failed" | "expired" | "refunded" | "partially_refunded" | "disputed";
|
|
3949
|
+
status?: "pending" | "paid" | "failed" | "expired" | "refunded" | "partially_refunded" | "disputed" | "voided";
|
|
3384
3950
|
/**
|
|
3385
3951
|
* Comma-separated statuses to omit. Intended for hiding abandoned checkouts (`pending,expired`) from a merchant's default order view — a buyer who closes the Stripe page leaves a `pending` order that later sweeps to `expired`, and neither is a sale. Unknown values are ignored; ignored entirely when `status` is set.
|
|
3386
3952
|
*/
|
|
3387
3953
|
exclude_status?: string;
|
|
3954
|
+
/**
|
|
3955
|
+
* Restrict to one order source. DEFAULT (omitted) lists checkout and subscription orders only — invoices are a different surface (their own numbering, due dates and reminders) and live in the Invoices view; pass `invoice` to list them here, or `all` for everything.
|
|
3956
|
+
*/
|
|
3957
|
+
source?: "checkout" | "subscription" | "invoice" | "all";
|
|
3388
3958
|
/**
|
|
3389
3959
|
* Case-insensitive exact match on the buyer email
|
|
3390
3960
|
*/
|
|
@@ -3533,7 +4103,7 @@ type ResendOrderReceiptErrors = {
|
|
|
3533
4103
|
*/
|
|
3534
4104
|
404: Error;
|
|
3535
4105
|
/**
|
|
3536
|
-
* Order has not been fulfilled, is refunded or disputed,
|
|
4106
|
+
* Order has not been fulfilled, is refunded or disputed, an email dispatch is already in flight, or the order is an invoice (invoices resend through /invoices/{id}/resend)
|
|
3537
4107
|
*/
|
|
3538
4108
|
409: Error;
|
|
3539
4109
|
/**
|
|
@@ -3567,7 +4137,7 @@ type ResetOrderDownloadsErrors = {
|
|
|
3567
4137
|
*/
|
|
3568
4138
|
404: Error;
|
|
3569
4139
|
/**
|
|
3570
|
-
* Order is not in a downloadable state
|
|
4140
|
+
* Order is not in a downloadable state, or is an invoice (invoices have no downloads)
|
|
3571
4141
|
*/
|
|
3572
4142
|
409: Error;
|
|
3573
4143
|
};
|
|
@@ -3613,6 +4183,10 @@ type ListCustomersData = {
|
|
|
3613
4183
|
body?: never;
|
|
3614
4184
|
path?: never;
|
|
3615
4185
|
query?: {
|
|
4186
|
+
/**
|
|
4187
|
+
* Case-insensitive substring match on email or name — the agent's find_customer lookup. Ignored when `email` is given.
|
|
4188
|
+
*/
|
|
4189
|
+
q?: string;
|
|
3616
4190
|
/**
|
|
3617
4191
|
* Case-insensitive exact-match filter on the customer email
|
|
3618
4192
|
*/
|
|
@@ -3950,7 +4524,7 @@ type SetOrderFulfillmentErrors = {
|
|
|
3950
4524
|
*/
|
|
3951
4525
|
404: unknown;
|
|
3952
4526
|
/**
|
|
3953
|
-
* Order status does not allow merchant fulfillment
|
|
4527
|
+
* Order status does not allow merchant fulfillment, or the order is an invoice (invoices have no fulfillment)
|
|
3954
4528
|
*/
|
|
3955
4529
|
409: unknown;
|
|
3956
4530
|
};
|
|
@@ -4121,6 +4695,1017 @@ type CreatePreviewSessionResponses = {
|
|
|
4121
4695
|
200: PreviewSessionResult;
|
|
4122
4696
|
};
|
|
4123
4697
|
type CreatePreviewSessionResponse = CreatePreviewSessionResponses[keyof CreatePreviewSessionResponses];
|
|
4698
|
+
type ListInvoicesData = {
|
|
4699
|
+
body?: never;
|
|
4700
|
+
path?: never;
|
|
4701
|
+
query?: {
|
|
4702
|
+
site_id?: string;
|
|
4703
|
+
/**
|
|
4704
|
+
* Comma-separated derived labels to keep (awaiting_payment, overdue, paid, voided, …)
|
|
4705
|
+
*/
|
|
4706
|
+
label?: string;
|
|
4707
|
+
/**
|
|
4708
|
+
* Comma-separated raw statuses
|
|
4709
|
+
*/
|
|
4710
|
+
status?: string;
|
|
4711
|
+
customer_email?: string;
|
|
4712
|
+
customer_id?: string;
|
|
4713
|
+
retainer_id?: string;
|
|
4714
|
+
/**
|
|
4715
|
+
* Case-insensitive substring on the invoice number, the recipient's name or email — "ACME-0007", "bob"
|
|
4716
|
+
*/
|
|
4717
|
+
q?: string;
|
|
4718
|
+
/**
|
|
4719
|
+
* Created on/after (YYYY-MM-DD)
|
|
4720
|
+
*/
|
|
4721
|
+
from?: string;
|
|
4722
|
+
/**
|
|
4723
|
+
* Created on/before (YYYY-MM-DD)
|
|
4724
|
+
*/
|
|
4725
|
+
to?: string;
|
|
4726
|
+
include?: string;
|
|
4727
|
+
limit?: string;
|
|
4728
|
+
offset?: string;
|
|
4729
|
+
};
|
|
4730
|
+
url: "/api/v1/invoices";
|
|
4731
|
+
};
|
|
4732
|
+
type ListInvoicesErrors = {
|
|
4733
|
+
/**
|
|
4734
|
+
* Bad scope
|
|
4735
|
+
*/
|
|
4736
|
+
400: InvoiceError;
|
|
4737
|
+
/**
|
|
4738
|
+
* Unauthorized
|
|
4739
|
+
*/
|
|
4740
|
+
401: InvoiceError;
|
|
4741
|
+
};
|
|
4742
|
+
type ListInvoicesError = ListInvoicesErrors[keyof ListInvoicesErrors];
|
|
4743
|
+
type ListInvoicesResponses = {
|
|
4744
|
+
/**
|
|
4745
|
+
* Invoices
|
|
4746
|
+
*/
|
|
4747
|
+
200: InvoicesList;
|
|
4748
|
+
};
|
|
4749
|
+
type ListInvoicesResponse = ListInvoicesResponses[keyof ListInvoicesResponses];
|
|
4750
|
+
type CreateInvoiceData = {
|
|
4751
|
+
body: CreateInvoice;
|
|
4752
|
+
path?: never;
|
|
4753
|
+
query?: never;
|
|
4754
|
+
url: "/api/v1/invoices";
|
|
4755
|
+
};
|
|
4756
|
+
type CreateInvoiceErrors = {
|
|
4757
|
+
/**
|
|
4758
|
+
* Invalid input, content rule, or billing_address_required
|
|
4759
|
+
*/
|
|
4760
|
+
400: InvoiceError;
|
|
4761
|
+
/**
|
|
4762
|
+
* Unauthorized
|
|
4763
|
+
*/
|
|
4764
|
+
401: InvoiceError;
|
|
4765
|
+
/**
|
|
4766
|
+
* Site tokens are not permitted, or invoicing is disabled
|
|
4767
|
+
*/
|
|
4768
|
+
403: InvoiceError;
|
|
4769
|
+
/**
|
|
4770
|
+
* Invoice not found
|
|
4771
|
+
*/
|
|
4772
|
+
404: InvoiceError;
|
|
4773
|
+
/**
|
|
4774
|
+
* The invoice is not in a state that allows this
|
|
4775
|
+
*/
|
|
4776
|
+
409: InvoiceError;
|
|
4777
|
+
/**
|
|
4778
|
+
* Per-site invoice budget exceeded
|
|
4779
|
+
*/
|
|
4780
|
+
429: InvoiceError;
|
|
4781
|
+
/**
|
|
4782
|
+
* Stripe unreachable — retry
|
|
4783
|
+
*/
|
|
4784
|
+
502: InvoiceError;
|
|
4785
|
+
};
|
|
4786
|
+
type CreateInvoiceError = CreateInvoiceErrors[keyof CreateInvoiceErrors];
|
|
4787
|
+
type CreateInvoiceResponses = {
|
|
4788
|
+
/**
|
|
4789
|
+
* Created and sent
|
|
4790
|
+
*/
|
|
4791
|
+
201: CreateInvoiceResult;
|
|
4792
|
+
/**
|
|
4793
|
+
* Creation continues in the background
|
|
4794
|
+
*/
|
|
4795
|
+
202: CreateInvoiceResult;
|
|
4796
|
+
};
|
|
4797
|
+
type CreateInvoiceResponse = CreateInvoiceResponses[keyof CreateInvoiceResponses];
|
|
4798
|
+
type GetInvoiceData = {
|
|
4799
|
+
body?: never;
|
|
4800
|
+
path: {
|
|
4801
|
+
invoiceId: string;
|
|
4802
|
+
};
|
|
4803
|
+
query?: never;
|
|
4804
|
+
url: "/api/v1/invoices/{invoiceId}";
|
|
4805
|
+
};
|
|
4806
|
+
type GetInvoiceErrors = {
|
|
4807
|
+
/**
|
|
4808
|
+
* Unauthorized
|
|
4809
|
+
*/
|
|
4810
|
+
401: InvoiceError;
|
|
4811
|
+
/**
|
|
4812
|
+
* Not found
|
|
4813
|
+
*/
|
|
4814
|
+
404: InvoiceError;
|
|
4815
|
+
};
|
|
4816
|
+
type GetInvoiceError = GetInvoiceErrors[keyof GetInvoiceErrors];
|
|
4817
|
+
type GetInvoiceResponses = {
|
|
4818
|
+
/**
|
|
4819
|
+
* The invoice
|
|
4820
|
+
*/
|
|
4821
|
+
200: Invoice;
|
|
4822
|
+
};
|
|
4823
|
+
type GetInvoiceResponse = GetInvoiceResponses[keyof GetInvoiceResponses];
|
|
4824
|
+
type PreviewInvoiceData = {
|
|
4825
|
+
body: PreviewInvoice & {
|
|
4826
|
+
site_id?: string;
|
|
4827
|
+
};
|
|
4828
|
+
path?: never;
|
|
4829
|
+
query?: never;
|
|
4830
|
+
url: "/api/v1/invoices/preview";
|
|
4831
|
+
};
|
|
4832
|
+
type PreviewInvoiceErrors = {
|
|
4833
|
+
/**
|
|
4834
|
+
* Invalid proposal
|
|
4835
|
+
*/
|
|
4836
|
+
400: InvoiceError;
|
|
4837
|
+
/**
|
|
4838
|
+
* Unauthorized
|
|
4839
|
+
*/
|
|
4840
|
+
401: InvoiceError;
|
|
4841
|
+
};
|
|
4842
|
+
type PreviewInvoiceError = PreviewInvoiceErrors[keyof PreviewInvoiceErrors];
|
|
4843
|
+
type PreviewInvoiceResponses = {
|
|
4844
|
+
/**
|
|
4845
|
+
* Rendered email
|
|
4846
|
+
*/
|
|
4847
|
+
200: InvoicePreview;
|
|
4848
|
+
};
|
|
4849
|
+
type PreviewInvoiceResponse = PreviewInvoiceResponses[keyof PreviewInvoiceResponses];
|
|
4850
|
+
type GetInvoicePreviewData = {
|
|
4851
|
+
body?: never;
|
|
4852
|
+
path: {
|
|
4853
|
+
invoiceId: string;
|
|
4854
|
+
};
|
|
4855
|
+
query?: never;
|
|
4856
|
+
url: "/api/v1/invoices/{invoiceId}/preview";
|
|
4857
|
+
};
|
|
4858
|
+
type GetInvoicePreviewErrors = {
|
|
4859
|
+
/**
|
|
4860
|
+
* Unauthorized
|
|
4861
|
+
*/
|
|
4862
|
+
401: InvoiceError;
|
|
4863
|
+
/**
|
|
4864
|
+
* Not found
|
|
4865
|
+
*/
|
|
4866
|
+
404: InvoiceError;
|
|
4867
|
+
};
|
|
4868
|
+
type GetInvoicePreviewError = GetInvoicePreviewErrors[keyof GetInvoicePreviewErrors];
|
|
4869
|
+
type GetInvoicePreviewResponses = {
|
|
4870
|
+
/**
|
|
4871
|
+
* Rendered email
|
|
4872
|
+
*/
|
|
4873
|
+
200: InvoicePreview;
|
|
4874
|
+
};
|
|
4875
|
+
type GetInvoicePreviewResponse = GetInvoicePreviewResponses[keyof GetInvoicePreviewResponses];
|
|
4876
|
+
type VoidInvoiceData = {
|
|
4877
|
+
body: VoidInvoice;
|
|
4878
|
+
path: {
|
|
4879
|
+
invoiceId: string;
|
|
4880
|
+
};
|
|
4881
|
+
query?: never;
|
|
4882
|
+
url: "/api/v1/invoices/{invoiceId}/void";
|
|
4883
|
+
};
|
|
4884
|
+
type VoidInvoiceErrors = {
|
|
4885
|
+
/**
|
|
4886
|
+
* Invalid reissue (refused BEFORE the original is voided — it is left untouched)
|
|
4887
|
+
*/
|
|
4888
|
+
400: InvoiceError;
|
|
4889
|
+
/**
|
|
4890
|
+
* Unauthorized
|
|
4891
|
+
*/
|
|
4892
|
+
401: InvoiceError;
|
|
4893
|
+
/**
|
|
4894
|
+
* Site tokens are not permitted, or invoicing is disabled
|
|
4895
|
+
*/
|
|
4896
|
+
403: InvoiceError;
|
|
4897
|
+
/**
|
|
4898
|
+
* Invoice not found
|
|
4899
|
+
*/
|
|
4900
|
+
404: InvoiceError;
|
|
4901
|
+
/**
|
|
4902
|
+
* The invoice is not in a state that allows this
|
|
4903
|
+
*/
|
|
4904
|
+
409: InvoiceError;
|
|
4905
|
+
/**
|
|
4906
|
+
* Reissue refused: the site's invoice budget is spent — the original is left untouched
|
|
4907
|
+
*/
|
|
4908
|
+
429: InvoiceError;
|
|
4909
|
+
/**
|
|
4910
|
+
* Stripe unreachable — retry
|
|
4911
|
+
*/
|
|
4912
|
+
502: InvoiceError;
|
|
4913
|
+
};
|
|
4914
|
+
type VoidInvoiceError = VoidInvoiceErrors[keyof VoidInvoiceErrors];
|
|
4915
|
+
type VoidInvoiceResponses = {
|
|
4916
|
+
/**
|
|
4917
|
+
* Voided
|
|
4918
|
+
*/
|
|
4919
|
+
200: VoidInvoiceResult;
|
|
4920
|
+
};
|
|
4921
|
+
type VoidInvoiceResponse = VoidInvoiceResponses[keyof VoidInvoiceResponses];
|
|
4922
|
+
type ResendInvoiceData = {
|
|
4923
|
+
body: InvoiceSiteBody;
|
|
4924
|
+
path: {
|
|
4925
|
+
invoiceId: string;
|
|
4926
|
+
};
|
|
4927
|
+
query?: never;
|
|
4928
|
+
url: "/api/v1/invoices/{invoiceId}/resend";
|
|
4929
|
+
};
|
|
4930
|
+
type ResendInvoiceErrors = {
|
|
4931
|
+
/**
|
|
4932
|
+
* Invalid request
|
|
4933
|
+
*/
|
|
4934
|
+
400: InvoiceError;
|
|
4935
|
+
/**
|
|
4936
|
+
* Unauthorized
|
|
4937
|
+
*/
|
|
4938
|
+
401: InvoiceError;
|
|
4939
|
+
/**
|
|
4940
|
+
* Site tokens are not permitted, or invoicing is disabled
|
|
4941
|
+
*/
|
|
4942
|
+
403: InvoiceError;
|
|
4943
|
+
/**
|
|
4944
|
+
* Invoice not found
|
|
4945
|
+
*/
|
|
4946
|
+
404: InvoiceError;
|
|
4947
|
+
/**
|
|
4948
|
+
* The invoice is not in a state that allows this
|
|
4949
|
+
*/
|
|
4950
|
+
409: InvoiceError;
|
|
4951
|
+
/**
|
|
4952
|
+
* This recipient was emailed recently — the per-recipient cooldown (one buyer email an hour, six a day, first send of an invoice exempt)
|
|
4953
|
+
*/
|
|
4954
|
+
429: RecipientCooldownError;
|
|
4955
|
+
/**
|
|
4956
|
+
* Stripe unreachable — retry
|
|
4957
|
+
*/
|
|
4958
|
+
502: InvoiceError;
|
|
4959
|
+
};
|
|
4960
|
+
type ResendInvoiceError = ResendInvoiceErrors[keyof ResendInvoiceErrors];
|
|
4961
|
+
type ResendInvoiceResponses = {
|
|
4962
|
+
/**
|
|
4963
|
+
* Queued
|
|
4964
|
+
*/
|
|
4965
|
+
202: RemindInvoiceResult;
|
|
4966
|
+
};
|
|
4967
|
+
type ResendInvoiceResponse = ResendInvoiceResponses[keyof ResendInvoiceResponses];
|
|
4968
|
+
type RemindInvoiceData = {
|
|
4969
|
+
body: InvoiceSiteBody;
|
|
4970
|
+
path: {
|
|
4971
|
+
invoiceId: string;
|
|
4972
|
+
};
|
|
4973
|
+
query?: never;
|
|
4974
|
+
url: "/api/v1/invoices/{invoiceId}/remind";
|
|
4975
|
+
};
|
|
4976
|
+
type RemindInvoiceErrors = {
|
|
4977
|
+
/**
|
|
4978
|
+
* Invalid request
|
|
4979
|
+
*/
|
|
4980
|
+
400: InvoiceError;
|
|
4981
|
+
/**
|
|
4982
|
+
* Unauthorized
|
|
4983
|
+
*/
|
|
4984
|
+
401: InvoiceError;
|
|
4985
|
+
/**
|
|
4986
|
+
* Site tokens are not permitted, or invoicing is disabled
|
|
4987
|
+
*/
|
|
4988
|
+
403: InvoiceError;
|
|
4989
|
+
/**
|
|
4990
|
+
* Invoice not found
|
|
4991
|
+
*/
|
|
4992
|
+
404: InvoiceError;
|
|
4993
|
+
/**
|
|
4994
|
+
* The invoice is not in a state that allows this
|
|
4995
|
+
*/
|
|
4996
|
+
409: InvoiceError;
|
|
4997
|
+
/**
|
|
4998
|
+
* This recipient was emailed recently — the per-recipient cooldown (one buyer email an hour, six a day, first send of an invoice exempt)
|
|
4999
|
+
*/
|
|
5000
|
+
429: RecipientCooldownError;
|
|
5001
|
+
/**
|
|
5002
|
+
* Stripe unreachable — retry
|
|
5003
|
+
*/
|
|
5004
|
+
502: InvoiceError;
|
|
5005
|
+
};
|
|
5006
|
+
type RemindInvoiceError = RemindInvoiceErrors[keyof RemindInvoiceErrors];
|
|
5007
|
+
type RemindInvoiceResponses = {
|
|
5008
|
+
/**
|
|
5009
|
+
* Queued
|
|
5010
|
+
*/
|
|
5011
|
+
202: RemindInvoiceResult;
|
|
5012
|
+
};
|
|
5013
|
+
type RemindInvoiceResponse = RemindInvoiceResponses[keyof RemindInvoiceResponses];
|
|
5014
|
+
type SnoozeInvoiceData = {
|
|
5015
|
+
body: SnoozeInvoice;
|
|
5016
|
+
path: {
|
|
5017
|
+
invoiceId: string;
|
|
5018
|
+
};
|
|
5019
|
+
query?: never;
|
|
5020
|
+
url: "/api/v1/invoices/{invoiceId}/snooze";
|
|
5021
|
+
};
|
|
5022
|
+
type SnoozeInvoiceErrors = {
|
|
5023
|
+
/**
|
|
5024
|
+
* Invalid date
|
|
5025
|
+
*/
|
|
5026
|
+
400: InvoiceError;
|
|
5027
|
+
/**
|
|
5028
|
+
* Unauthorized
|
|
5029
|
+
*/
|
|
5030
|
+
401: InvoiceError;
|
|
5031
|
+
/**
|
|
5032
|
+
* Site tokens are not permitted, or invoicing is disabled
|
|
5033
|
+
*/
|
|
5034
|
+
403: InvoiceError;
|
|
5035
|
+
/**
|
|
5036
|
+
* Invoice not found
|
|
5037
|
+
*/
|
|
5038
|
+
404: InvoiceError;
|
|
5039
|
+
/**
|
|
5040
|
+
* The invoice is not in a state that allows this
|
|
5041
|
+
*/
|
|
5042
|
+
409: InvoiceError;
|
|
5043
|
+
/**
|
|
5044
|
+
* Stripe unreachable — retry
|
|
5045
|
+
*/
|
|
5046
|
+
502: InvoiceError;
|
|
5047
|
+
};
|
|
5048
|
+
type SnoozeInvoiceError = SnoozeInvoiceErrors[keyof SnoozeInvoiceErrors];
|
|
5049
|
+
type SnoozeInvoiceResponses = {
|
|
5050
|
+
/**
|
|
5051
|
+
* Updated
|
|
5052
|
+
*/
|
|
5053
|
+
200: Invoice;
|
|
5054
|
+
};
|
|
5055
|
+
type SnoozeInvoiceResponse = SnoozeInvoiceResponses[keyof SnoozeInvoiceResponses];
|
|
5056
|
+
type SetInvoiceRemindersData = {
|
|
5057
|
+
body: SetInvoiceReminders;
|
|
5058
|
+
path: {
|
|
5059
|
+
invoiceId: string;
|
|
5060
|
+
};
|
|
5061
|
+
query?: never;
|
|
5062
|
+
url: "/api/v1/invoices/{invoiceId}/reminders";
|
|
5063
|
+
};
|
|
5064
|
+
type SetInvoiceRemindersErrors = {
|
|
5065
|
+
/**
|
|
5066
|
+
* Invalid schedule
|
|
5067
|
+
*/
|
|
5068
|
+
400: InvoiceError;
|
|
5069
|
+
/**
|
|
5070
|
+
* Unauthorized
|
|
5071
|
+
*/
|
|
5072
|
+
401: InvoiceError;
|
|
5073
|
+
/**
|
|
5074
|
+
* Site tokens are not permitted, or invoicing is disabled
|
|
5075
|
+
*/
|
|
5076
|
+
403: InvoiceError;
|
|
5077
|
+
/**
|
|
5078
|
+
* Invoice not found
|
|
5079
|
+
*/
|
|
5080
|
+
404: InvoiceError;
|
|
5081
|
+
/**
|
|
5082
|
+
* The invoice is not in a state that allows this
|
|
5083
|
+
*/
|
|
5084
|
+
409: InvoiceError;
|
|
5085
|
+
/**
|
|
5086
|
+
* Stripe unreachable — retry
|
|
5087
|
+
*/
|
|
5088
|
+
502: InvoiceError;
|
|
5089
|
+
};
|
|
5090
|
+
type SetInvoiceRemindersError = SetInvoiceRemindersErrors[keyof SetInvoiceRemindersErrors];
|
|
5091
|
+
type SetInvoiceRemindersResponses = {
|
|
5092
|
+
/**
|
|
5093
|
+
* Updated
|
|
5094
|
+
*/
|
|
5095
|
+
200: Invoice;
|
|
5096
|
+
};
|
|
5097
|
+
type SetInvoiceRemindersResponse = SetInvoiceRemindersResponses[keyof SetInvoiceRemindersResponses];
|
|
5098
|
+
type MarkInvoicePaidData = {
|
|
5099
|
+
body: MarkInvoicePaid;
|
|
5100
|
+
path: {
|
|
5101
|
+
invoiceId: string;
|
|
5102
|
+
};
|
|
5103
|
+
query?: never;
|
|
5104
|
+
url: "/api/v1/invoices/{invoiceId}/mark-paid";
|
|
5105
|
+
};
|
|
5106
|
+
type MarkInvoicePaidErrors = {
|
|
5107
|
+
/**
|
|
5108
|
+
* Invalid request
|
|
5109
|
+
*/
|
|
5110
|
+
400: InvoiceError;
|
|
5111
|
+
/**
|
|
5112
|
+
* Unauthorized
|
|
5113
|
+
*/
|
|
5114
|
+
401: InvoiceError;
|
|
5115
|
+
/**
|
|
5116
|
+
* Site tokens are not permitted, or invoicing is disabled
|
|
5117
|
+
*/
|
|
5118
|
+
403: InvoiceError;
|
|
5119
|
+
/**
|
|
5120
|
+
* Invoice not found
|
|
5121
|
+
*/
|
|
5122
|
+
404: InvoiceError;
|
|
5123
|
+
/**
|
|
5124
|
+
* The invoice is not in a state that allows this
|
|
5125
|
+
*/
|
|
5126
|
+
409: InvoiceError;
|
|
5127
|
+
/**
|
|
5128
|
+
* Stripe unreachable — retry
|
|
5129
|
+
*/
|
|
5130
|
+
502: InvoiceError;
|
|
5131
|
+
};
|
|
5132
|
+
type MarkInvoicePaidError = MarkInvoicePaidErrors[keyof MarkInvoicePaidErrors];
|
|
5133
|
+
type MarkInvoicePaidResponses = {
|
|
5134
|
+
/**
|
|
5135
|
+
* Recorded
|
|
5136
|
+
*/
|
|
5137
|
+
200: MarkInvoicePaidResult;
|
|
5138
|
+
};
|
|
5139
|
+
type MarkInvoicePaidResponse = MarkInvoicePaidResponses[keyof MarkInvoicePaidResponses];
|
|
5140
|
+
type MarkInvoiceUncollectibleData = {
|
|
5141
|
+
body: InvoiceSiteBody;
|
|
5142
|
+
path: {
|
|
5143
|
+
invoiceId: string;
|
|
5144
|
+
};
|
|
5145
|
+
query?: never;
|
|
5146
|
+
url: "/api/v1/invoices/{invoiceId}/mark-uncollectible";
|
|
5147
|
+
};
|
|
5148
|
+
type MarkInvoiceUncollectibleErrors = {
|
|
5149
|
+
/**
|
|
5150
|
+
* Invalid request
|
|
5151
|
+
*/
|
|
5152
|
+
400: InvoiceError;
|
|
5153
|
+
/**
|
|
5154
|
+
* Unauthorized
|
|
5155
|
+
*/
|
|
5156
|
+
401: InvoiceError;
|
|
5157
|
+
/**
|
|
5158
|
+
* Site tokens are not permitted, or invoicing is disabled
|
|
5159
|
+
*/
|
|
5160
|
+
403: InvoiceError;
|
|
5161
|
+
/**
|
|
5162
|
+
* Invoice not found
|
|
5163
|
+
*/
|
|
5164
|
+
404: InvoiceError;
|
|
5165
|
+
/**
|
|
5166
|
+
* The invoice is not in a state that allows this
|
|
5167
|
+
*/
|
|
5168
|
+
409: InvoiceError;
|
|
5169
|
+
/**
|
|
5170
|
+
* Stripe unreachable — retry
|
|
5171
|
+
*/
|
|
5172
|
+
502: InvoiceError;
|
|
5173
|
+
};
|
|
5174
|
+
type MarkInvoiceUncollectibleError = MarkInvoiceUncollectibleErrors[keyof MarkInvoiceUncollectibleErrors];
|
|
5175
|
+
type MarkInvoiceUncollectibleResponses = {
|
|
5176
|
+
/**
|
|
5177
|
+
* Written off
|
|
5178
|
+
*/
|
|
5179
|
+
200: Invoice;
|
|
5180
|
+
};
|
|
5181
|
+
type MarkInvoiceUncollectibleResponse = MarkInvoiceUncollectibleResponses[keyof MarkInvoiceUncollectibleResponses];
|
|
5182
|
+
type UpdateInvoiceRecipientData = {
|
|
5183
|
+
body: UpdateInvoiceRecipient;
|
|
5184
|
+
path: {
|
|
5185
|
+
invoiceId: string;
|
|
5186
|
+
};
|
|
5187
|
+
query?: never;
|
|
5188
|
+
url: "/api/v1/invoices/{invoiceId}/recipient";
|
|
5189
|
+
};
|
|
5190
|
+
type UpdateInvoiceRecipientErrors = {
|
|
5191
|
+
/**
|
|
5192
|
+
* Invalid email
|
|
5193
|
+
*/
|
|
5194
|
+
400: InvoiceError;
|
|
5195
|
+
/**
|
|
5196
|
+
* Unauthorized
|
|
5197
|
+
*/
|
|
5198
|
+
401: InvoiceError;
|
|
5199
|
+
/**
|
|
5200
|
+
* Site tokens are not permitted, or invoicing is disabled
|
|
5201
|
+
*/
|
|
5202
|
+
403: InvoiceError;
|
|
5203
|
+
/**
|
|
5204
|
+
* Invoice not found
|
|
5205
|
+
*/
|
|
5206
|
+
404: InvoiceError;
|
|
5207
|
+
/**
|
|
5208
|
+
* The invoice is not in a state that allows this
|
|
5209
|
+
*/
|
|
5210
|
+
409: InvoiceError;
|
|
5211
|
+
/**
|
|
5212
|
+
* Stripe unreachable — retry
|
|
5213
|
+
*/
|
|
5214
|
+
502: InvoiceError;
|
|
5215
|
+
};
|
|
5216
|
+
type UpdateInvoiceRecipientError = UpdateInvoiceRecipientErrors[keyof UpdateInvoiceRecipientErrors];
|
|
5217
|
+
type UpdateInvoiceRecipientResponses = {
|
|
5218
|
+
/**
|
|
5219
|
+
* Updated — `communication_id` says whether a resend went out, `customer_updated` whether the customer record changed
|
|
5220
|
+
*/
|
|
5221
|
+
200: UpdateRecipientResult;
|
|
5222
|
+
};
|
|
5223
|
+
type UpdateInvoiceRecipientResponse = UpdateInvoiceRecipientResponses[keyof UpdateInvoiceRecipientResponses];
|
|
5224
|
+
type UpdateCustomerBillingData = {
|
|
5225
|
+
body: UpdateCustomerBilling;
|
|
5226
|
+
path: {
|
|
5227
|
+
customerId: string;
|
|
5228
|
+
};
|
|
5229
|
+
query?: never;
|
|
5230
|
+
url: "/api/v1/customers/{customerId}/billing";
|
|
5231
|
+
};
|
|
5232
|
+
type UpdateCustomerBillingErrors = {
|
|
5233
|
+
/**
|
|
5234
|
+
* Invalid bill-to
|
|
5235
|
+
*/
|
|
5236
|
+
400: InvoiceError;
|
|
5237
|
+
/**
|
|
5238
|
+
* Unauthorized
|
|
5239
|
+
*/
|
|
5240
|
+
401: InvoiceError;
|
|
5241
|
+
/**
|
|
5242
|
+
* Site tokens are not permitted, or invoicing is disabled
|
|
5243
|
+
*/
|
|
5244
|
+
403: InvoiceError;
|
|
5245
|
+
/**
|
|
5246
|
+
* Invoice not found
|
|
5247
|
+
*/
|
|
5248
|
+
404: InvoiceError;
|
|
5249
|
+
/**
|
|
5250
|
+
* The invoice is not in a state that allows this
|
|
5251
|
+
*/
|
|
5252
|
+
409: InvoiceError;
|
|
5253
|
+
/**
|
|
5254
|
+
* Stripe unreachable — retry
|
|
5255
|
+
*/
|
|
5256
|
+
502: InvoiceError;
|
|
5257
|
+
};
|
|
5258
|
+
type UpdateCustomerBillingError = UpdateCustomerBillingErrors[keyof UpdateCustomerBillingErrors];
|
|
5259
|
+
type UpdateCustomerBillingResponses = {
|
|
5260
|
+
/**
|
|
5261
|
+
* Updated
|
|
5262
|
+
*/
|
|
5263
|
+
200: CustomerBilling;
|
|
5264
|
+
};
|
|
5265
|
+
type UpdateCustomerBillingResponse = UpdateCustomerBillingResponses[keyof UpdateCustomerBillingResponses];
|
|
5266
|
+
type GetInvoiceSettingsWithSiteTokenData = {
|
|
5267
|
+
body?: never;
|
|
5268
|
+
path?: never;
|
|
5269
|
+
query?: never;
|
|
5270
|
+
url: "/api/v1/invoice-settings";
|
|
5271
|
+
};
|
|
5272
|
+
type GetInvoiceSettingsWithSiteTokenErrors = {
|
|
5273
|
+
/**
|
|
5274
|
+
* Requires a site token
|
|
5275
|
+
*/
|
|
5276
|
+
401: InvoiceError;
|
|
5277
|
+
};
|
|
5278
|
+
type GetInvoiceSettingsWithSiteTokenError = GetInvoiceSettingsWithSiteTokenErrors[keyof GetInvoiceSettingsWithSiteTokenErrors];
|
|
5279
|
+
type GetInvoiceSettingsWithSiteTokenResponses = {
|
|
5280
|
+
/**
|
|
5281
|
+
* Settings
|
|
5282
|
+
*/
|
|
5283
|
+
200: InvoiceSettings;
|
|
5284
|
+
};
|
|
5285
|
+
type GetInvoiceSettingsWithSiteTokenResponse = GetInvoiceSettingsWithSiteTokenResponses[keyof GetInvoiceSettingsWithSiteTokenResponses];
|
|
5286
|
+
type GetInvoiceSettingsData = {
|
|
5287
|
+
body?: never;
|
|
5288
|
+
path: {
|
|
5289
|
+
siteId: string;
|
|
5290
|
+
};
|
|
5291
|
+
query?: never;
|
|
5292
|
+
url: "/api/v1/sites/{siteId}/invoice-settings";
|
|
5293
|
+
};
|
|
5294
|
+
type GetInvoiceSettingsErrors = {
|
|
5295
|
+
/**
|
|
5296
|
+
* Bad scope
|
|
5297
|
+
*/
|
|
5298
|
+
400: InvoiceError;
|
|
5299
|
+
/**
|
|
5300
|
+
* Unauthorized
|
|
5301
|
+
*/
|
|
5302
|
+
401: InvoiceError;
|
|
5303
|
+
/**
|
|
5304
|
+
* Not found
|
|
5305
|
+
*/
|
|
5306
|
+
404: InvoiceError;
|
|
5307
|
+
};
|
|
5308
|
+
type GetInvoiceSettingsError = GetInvoiceSettingsErrors[keyof GetInvoiceSettingsErrors];
|
|
5309
|
+
type GetInvoiceSettingsResponses = {
|
|
5310
|
+
/**
|
|
5311
|
+
* Settings
|
|
5312
|
+
*/
|
|
5313
|
+
200: InvoiceSettings;
|
|
5314
|
+
};
|
|
5315
|
+
type GetInvoiceSettingsResponse = GetInvoiceSettingsResponses[keyof GetInvoiceSettingsResponses];
|
|
5316
|
+
type UpdateInvoiceSettingsData = {
|
|
5317
|
+
body: UpdateInvoiceSettings;
|
|
5318
|
+
path: {
|
|
5319
|
+
siteId: string;
|
|
5320
|
+
};
|
|
5321
|
+
query?: never;
|
|
5322
|
+
url: "/api/v1/sites/{siteId}/invoice-settings";
|
|
5323
|
+
};
|
|
5324
|
+
type UpdateInvoiceSettingsErrors = {
|
|
5325
|
+
/**
|
|
5326
|
+
* Invalid value
|
|
5327
|
+
*/
|
|
5328
|
+
400: InvoiceError;
|
|
5329
|
+
/**
|
|
5330
|
+
* Unauthorized
|
|
5331
|
+
*/
|
|
5332
|
+
401: InvoiceError;
|
|
5333
|
+
/**
|
|
5334
|
+
* Site tokens are not permitted, or invoicing is disabled
|
|
5335
|
+
*/
|
|
5336
|
+
403: InvoiceError;
|
|
5337
|
+
/**
|
|
5338
|
+
* Invoice not found
|
|
5339
|
+
*/
|
|
5340
|
+
404: InvoiceError;
|
|
5341
|
+
/**
|
|
5342
|
+
* The invoice is not in a state that allows this
|
|
5343
|
+
*/
|
|
5344
|
+
409: InvoiceError;
|
|
5345
|
+
/**
|
|
5346
|
+
* Stripe unreachable — retry
|
|
5347
|
+
*/
|
|
5348
|
+
502: InvoiceError;
|
|
5349
|
+
};
|
|
5350
|
+
type UpdateInvoiceSettingsError = UpdateInvoiceSettingsErrors[keyof UpdateInvoiceSettingsErrors];
|
|
5351
|
+
type UpdateInvoiceSettingsResponses = {
|
|
5352
|
+
/**
|
|
5353
|
+
* Updated
|
|
5354
|
+
*/
|
|
5355
|
+
200: InvoiceSettings;
|
|
5356
|
+
};
|
|
5357
|
+
type UpdateInvoiceSettingsResponse = UpdateInvoiceSettingsResponses[keyof UpdateInvoiceSettingsResponses];
|
|
5358
|
+
type UpdateSiteInvoicingData = {
|
|
5359
|
+
body: UpdateSiteInvoicing;
|
|
5360
|
+
path: {
|
|
5361
|
+
siteId: string;
|
|
5362
|
+
};
|
|
5363
|
+
query?: never;
|
|
5364
|
+
url: "/api/v1/sites/{siteId}/invoicing";
|
|
5365
|
+
};
|
|
5366
|
+
type UpdateSiteInvoicingErrors = {
|
|
5367
|
+
/**
|
|
5368
|
+
* Unauthorized
|
|
5369
|
+
*/
|
|
5370
|
+
401: InvoiceError;
|
|
5371
|
+
/**
|
|
5372
|
+
* Site tokens are not permitted, or invoicing is disabled
|
|
5373
|
+
*/
|
|
5374
|
+
403: InvoiceError;
|
|
5375
|
+
/**
|
|
5376
|
+
* Invoice not found
|
|
5377
|
+
*/
|
|
5378
|
+
404: InvoiceError;
|
|
5379
|
+
/**
|
|
5380
|
+
* The invoice is not in a state that allows this
|
|
5381
|
+
*/
|
|
5382
|
+
409: InvoiceError;
|
|
5383
|
+
/**
|
|
5384
|
+
* Stripe unreachable — retry
|
|
5385
|
+
*/
|
|
5386
|
+
502: InvoiceError;
|
|
5387
|
+
};
|
|
5388
|
+
type UpdateSiteInvoicingError = UpdateSiteInvoicingErrors[keyof UpdateSiteInvoicingErrors];
|
|
5389
|
+
type UpdateSiteInvoicingResponses = {
|
|
5390
|
+
/**
|
|
5391
|
+
* Updated
|
|
5392
|
+
*/
|
|
5393
|
+
200: InvoiceSettings;
|
|
5394
|
+
};
|
|
5395
|
+
type UpdateSiteInvoicingResponse = UpdateSiteInvoicingResponses[keyof UpdateSiteInvoicingResponses];
|
|
5396
|
+
type ListRetainersData = {
|
|
5397
|
+
body?: never;
|
|
5398
|
+
path?: never;
|
|
5399
|
+
query?: {
|
|
5400
|
+
site_id?: string;
|
|
5401
|
+
/**
|
|
5402
|
+
* Comma-separated statuses
|
|
5403
|
+
*/
|
|
5404
|
+
status?: string;
|
|
5405
|
+
customer_email?: string;
|
|
5406
|
+
limit?: string;
|
|
5407
|
+
offset?: string;
|
|
5408
|
+
};
|
|
5409
|
+
url: "/api/v1/retainers";
|
|
5410
|
+
};
|
|
5411
|
+
type ListRetainersErrors = {
|
|
5412
|
+
/**
|
|
5413
|
+
* Bad request
|
|
5414
|
+
*/
|
|
5415
|
+
400: Error;
|
|
5416
|
+
/**
|
|
5417
|
+
* Unauthorized
|
|
5418
|
+
*/
|
|
5419
|
+
401: Error;
|
|
5420
|
+
};
|
|
5421
|
+
type ListRetainersError = ListRetainersErrors[keyof ListRetainersErrors];
|
|
5422
|
+
type ListRetainersResponses = {
|
|
5423
|
+
/**
|
|
5424
|
+
* Retainers
|
|
5425
|
+
*/
|
|
5426
|
+
200: RetainersList;
|
|
5427
|
+
};
|
|
5428
|
+
type ListRetainersResponse = ListRetainersResponses[keyof ListRetainersResponses];
|
|
5429
|
+
type CreateRetainerData = {
|
|
5430
|
+
body: CreateRetainer;
|
|
5431
|
+
path?: never;
|
|
5432
|
+
query?: never;
|
|
5433
|
+
url: "/api/v1/retainers";
|
|
5434
|
+
};
|
|
5435
|
+
type CreateRetainerErrors = {
|
|
5436
|
+
/**
|
|
5437
|
+
* Validation error, or a billing address is required
|
|
5438
|
+
*/
|
|
5439
|
+
400: RetainerError;
|
|
5440
|
+
/**
|
|
5441
|
+
* Unauthorized
|
|
5442
|
+
*/
|
|
5443
|
+
401: RetainerError;
|
|
5444
|
+
/**
|
|
5445
|
+
* Site tokens are not permitted, or invoicing is disabled
|
|
5446
|
+
*/
|
|
5447
|
+
403: RetainerError;
|
|
5448
|
+
/**
|
|
5449
|
+
* Retainer not found
|
|
5450
|
+
*/
|
|
5451
|
+
404: RetainerError;
|
|
5452
|
+
/**
|
|
5453
|
+
* The retainer is not in a state that allows this
|
|
5454
|
+
*/
|
|
5455
|
+
409: RetainerError;
|
|
5456
|
+
/**
|
|
5457
|
+
* Stripe unreachable — retry
|
|
5458
|
+
*/
|
|
5459
|
+
502: RetainerError;
|
|
5460
|
+
};
|
|
5461
|
+
type CreateRetainerError = CreateRetainerErrors[keyof CreateRetainerErrors];
|
|
5462
|
+
type CreateRetainerResponses = {
|
|
5463
|
+
/**
|
|
5464
|
+
* Created
|
|
5465
|
+
*/
|
|
5466
|
+
201: CreateRetainerResult;
|
|
5467
|
+
/**
|
|
5468
|
+
* Creation continues in the background
|
|
5469
|
+
*/
|
|
5470
|
+
202: CreateRetainerResult;
|
|
5471
|
+
};
|
|
5472
|
+
type CreateRetainerResponse = CreateRetainerResponses[keyof CreateRetainerResponses];
|
|
5473
|
+
type GetRetainerData = {
|
|
5474
|
+
body?: never;
|
|
5475
|
+
path: {
|
|
5476
|
+
retainerId: string;
|
|
5477
|
+
};
|
|
5478
|
+
query?: never;
|
|
5479
|
+
url: "/api/v1/retainers/{retainerId}";
|
|
5480
|
+
};
|
|
5481
|
+
type GetRetainerErrors = {
|
|
5482
|
+
/**
|
|
5483
|
+
* Unauthorized
|
|
5484
|
+
*/
|
|
5485
|
+
401: Error;
|
|
5486
|
+
/**
|
|
5487
|
+
* Not found
|
|
5488
|
+
*/
|
|
5489
|
+
404: Error;
|
|
5490
|
+
};
|
|
5491
|
+
type GetRetainerError = GetRetainerErrors[keyof GetRetainerErrors];
|
|
5492
|
+
type GetRetainerResponses = {
|
|
5493
|
+
/**
|
|
5494
|
+
* Retainer
|
|
5495
|
+
*/
|
|
5496
|
+
200: Retainer;
|
|
5497
|
+
};
|
|
5498
|
+
type GetRetainerResponse = GetRetainerResponses[keyof GetRetainerResponses];
|
|
5499
|
+
type UpdateRetainerData = {
|
|
5500
|
+
body: UpdateRetainer;
|
|
5501
|
+
path: {
|
|
5502
|
+
retainerId: string;
|
|
5503
|
+
};
|
|
5504
|
+
query?: never;
|
|
5505
|
+
url: "/api/v1/retainers/{retainerId}";
|
|
5506
|
+
};
|
|
5507
|
+
type UpdateRetainerErrors = {
|
|
5508
|
+
/**
|
|
5509
|
+
* Validation error, or a billing address is required
|
|
5510
|
+
*/
|
|
5511
|
+
400: RetainerError;
|
|
5512
|
+
/**
|
|
5513
|
+
* Unauthorized
|
|
5514
|
+
*/
|
|
5515
|
+
401: RetainerError;
|
|
5516
|
+
/**
|
|
5517
|
+
* Site tokens are not permitted, or invoicing is disabled
|
|
5518
|
+
*/
|
|
5519
|
+
403: RetainerError;
|
|
5520
|
+
/**
|
|
5521
|
+
* Retainer not found
|
|
5522
|
+
*/
|
|
5523
|
+
404: RetainerError;
|
|
5524
|
+
/**
|
|
5525
|
+
* The retainer is not in a state that allows this
|
|
5526
|
+
*/
|
|
5527
|
+
409: RetainerError;
|
|
5528
|
+
/**
|
|
5529
|
+
* Stripe unreachable — retry
|
|
5530
|
+
*/
|
|
5531
|
+
502: RetainerError;
|
|
5532
|
+
};
|
|
5533
|
+
type UpdateRetainerError = UpdateRetainerErrors[keyof UpdateRetainerErrors];
|
|
5534
|
+
type UpdateRetainerResponses = {
|
|
5535
|
+
/**
|
|
5536
|
+
* Updated
|
|
5537
|
+
*/
|
|
5538
|
+
200: Retainer;
|
|
5539
|
+
};
|
|
5540
|
+
type UpdateRetainerResponse = UpdateRetainerResponses[keyof UpdateRetainerResponses];
|
|
5541
|
+
type SkipNextRetainerCycleData = {
|
|
5542
|
+
body: RetainerSiteBody;
|
|
5543
|
+
path: {
|
|
5544
|
+
retainerId: string;
|
|
5545
|
+
};
|
|
5546
|
+
query?: never;
|
|
5547
|
+
url: "/api/v1/retainers/{retainerId}/skip-next";
|
|
5548
|
+
};
|
|
5549
|
+
type SkipNextRetainerCycleErrors = {
|
|
5550
|
+
/**
|
|
5551
|
+
* Validation error, or a billing address is required
|
|
5552
|
+
*/
|
|
5553
|
+
400: RetainerError;
|
|
5554
|
+
/**
|
|
5555
|
+
* Unauthorized
|
|
5556
|
+
*/
|
|
5557
|
+
401: RetainerError;
|
|
5558
|
+
/**
|
|
5559
|
+
* Site tokens are not permitted, or invoicing is disabled
|
|
5560
|
+
*/
|
|
5561
|
+
403: RetainerError;
|
|
5562
|
+
/**
|
|
5563
|
+
* Retainer not found
|
|
5564
|
+
*/
|
|
5565
|
+
404: RetainerError;
|
|
5566
|
+
/**
|
|
5567
|
+
* The retainer is not in a state that allows this
|
|
5568
|
+
*/
|
|
5569
|
+
409: RetainerError;
|
|
5570
|
+
/**
|
|
5571
|
+
* Stripe unreachable — retry
|
|
5572
|
+
*/
|
|
5573
|
+
502: RetainerError;
|
|
5574
|
+
};
|
|
5575
|
+
type SkipNextRetainerCycleError = SkipNextRetainerCycleErrors[keyof SkipNextRetainerCycleErrors];
|
|
5576
|
+
type SkipNextRetainerCycleResponses = {
|
|
5577
|
+
/**
|
|
5578
|
+
* Skipped
|
|
5579
|
+
*/
|
|
5580
|
+
200: Retainer;
|
|
5581
|
+
};
|
|
5582
|
+
type SkipNextRetainerCycleResponse = SkipNextRetainerCycleResponses[keyof SkipNextRetainerCycleResponses];
|
|
5583
|
+
type PauseRetainerData = {
|
|
5584
|
+
body: RetainerSiteBody;
|
|
5585
|
+
path: {
|
|
5586
|
+
retainerId: string;
|
|
5587
|
+
};
|
|
5588
|
+
query?: never;
|
|
5589
|
+
url: "/api/v1/retainers/{retainerId}/pause";
|
|
5590
|
+
};
|
|
5591
|
+
type PauseRetainerErrors = {
|
|
5592
|
+
/**
|
|
5593
|
+
* Validation error, or a billing address is required
|
|
5594
|
+
*/
|
|
5595
|
+
400: RetainerError;
|
|
5596
|
+
/**
|
|
5597
|
+
* Unauthorized
|
|
5598
|
+
*/
|
|
5599
|
+
401: RetainerError;
|
|
5600
|
+
/**
|
|
5601
|
+
* Site tokens are not permitted, or invoicing is disabled
|
|
5602
|
+
*/
|
|
5603
|
+
403: RetainerError;
|
|
5604
|
+
/**
|
|
5605
|
+
* Retainer not found
|
|
5606
|
+
*/
|
|
5607
|
+
404: RetainerError;
|
|
5608
|
+
/**
|
|
5609
|
+
* The retainer is not in a state that allows this
|
|
5610
|
+
*/
|
|
5611
|
+
409: RetainerError;
|
|
5612
|
+
/**
|
|
5613
|
+
* Stripe unreachable — retry
|
|
5614
|
+
*/
|
|
5615
|
+
502: RetainerError;
|
|
5616
|
+
};
|
|
5617
|
+
type PauseRetainerError = PauseRetainerErrors[keyof PauseRetainerErrors];
|
|
5618
|
+
type PauseRetainerResponses = {
|
|
5619
|
+
/**
|
|
5620
|
+
* Paused
|
|
5621
|
+
*/
|
|
5622
|
+
200: Retainer;
|
|
5623
|
+
};
|
|
5624
|
+
type PauseRetainerResponse = PauseRetainerResponses[keyof PauseRetainerResponses];
|
|
5625
|
+
type ResumeRetainerData = {
|
|
5626
|
+
body: RetainerSiteBody;
|
|
5627
|
+
path: {
|
|
5628
|
+
retainerId: string;
|
|
5629
|
+
};
|
|
5630
|
+
query?: never;
|
|
5631
|
+
url: "/api/v1/retainers/{retainerId}/resume";
|
|
5632
|
+
};
|
|
5633
|
+
type ResumeRetainerErrors = {
|
|
5634
|
+
/**
|
|
5635
|
+
* Validation error, or a billing address is required
|
|
5636
|
+
*/
|
|
5637
|
+
400: RetainerError;
|
|
5638
|
+
/**
|
|
5639
|
+
* Unauthorized
|
|
5640
|
+
*/
|
|
5641
|
+
401: RetainerError;
|
|
5642
|
+
/**
|
|
5643
|
+
* Site tokens are not permitted, or invoicing is disabled
|
|
5644
|
+
*/
|
|
5645
|
+
403: RetainerError;
|
|
5646
|
+
/**
|
|
5647
|
+
* Retainer not found
|
|
5648
|
+
*/
|
|
5649
|
+
404: RetainerError;
|
|
5650
|
+
/**
|
|
5651
|
+
* The retainer is not in a state that allows this
|
|
5652
|
+
*/
|
|
5653
|
+
409: RetainerError;
|
|
5654
|
+
/**
|
|
5655
|
+
* Stripe unreachable — retry
|
|
5656
|
+
*/
|
|
5657
|
+
502: RetainerError;
|
|
5658
|
+
};
|
|
5659
|
+
type ResumeRetainerError = ResumeRetainerErrors[keyof ResumeRetainerErrors];
|
|
5660
|
+
type ResumeRetainerResponses = {
|
|
5661
|
+
/**
|
|
5662
|
+
* Resumed
|
|
5663
|
+
*/
|
|
5664
|
+
200: Retainer;
|
|
5665
|
+
};
|
|
5666
|
+
type ResumeRetainerResponse = ResumeRetainerResponses[keyof ResumeRetainerResponses];
|
|
5667
|
+
type CancelRetainerData = {
|
|
5668
|
+
body: RetainerSiteBody;
|
|
5669
|
+
path: {
|
|
5670
|
+
retainerId: string;
|
|
5671
|
+
};
|
|
5672
|
+
query?: never;
|
|
5673
|
+
url: "/api/v1/retainers/{retainerId}/cancel";
|
|
5674
|
+
};
|
|
5675
|
+
type CancelRetainerErrors = {
|
|
5676
|
+
/**
|
|
5677
|
+
* Validation error, or a billing address is required
|
|
5678
|
+
*/
|
|
5679
|
+
400: RetainerError;
|
|
5680
|
+
/**
|
|
5681
|
+
* Unauthorized
|
|
5682
|
+
*/
|
|
5683
|
+
401: RetainerError;
|
|
5684
|
+
/**
|
|
5685
|
+
* Site tokens are not permitted, or invoicing is disabled
|
|
5686
|
+
*/
|
|
5687
|
+
403: RetainerError;
|
|
5688
|
+
/**
|
|
5689
|
+
* Retainer not found
|
|
5690
|
+
*/
|
|
5691
|
+
404: RetainerError;
|
|
5692
|
+
/**
|
|
5693
|
+
* The retainer is not in a state that allows this
|
|
5694
|
+
*/
|
|
5695
|
+
409: RetainerError;
|
|
5696
|
+
/**
|
|
5697
|
+
* Stripe unreachable — retry
|
|
5698
|
+
*/
|
|
5699
|
+
502: RetainerError;
|
|
5700
|
+
};
|
|
5701
|
+
type CancelRetainerError = CancelRetainerErrors[keyof CancelRetainerErrors];
|
|
5702
|
+
type CancelRetainerResponses = {
|
|
5703
|
+
/**
|
|
5704
|
+
* Canceling
|
|
5705
|
+
*/
|
|
5706
|
+
200: Retainer;
|
|
5707
|
+
};
|
|
5708
|
+
type CancelRetainerResponse = CancelRetainerResponses[keyof CancelRetainerResponses];
|
|
4124
5709
|
type ListFormsWithSiteTokenData = {
|
|
4125
5710
|
body?: never;
|
|
4126
5711
|
path?: never;
|
|
@@ -6121,6 +7706,122 @@ declare const reactivateSiteSubscriptionsTeardown: <ThrowOnError extends boolean
|
|
|
6121
7706
|
* Mints an is_preview customer session for the editor's account-page preview (R10): real session row, served ONLY is_test data, fixed 12-hour expiry (no sliding), refused by every checkout-creating path, and accepted only from the site's own preview host or an editor origin — never the public custom domain. A customers row is created/reused for (site, email). Requires an organization API key (sk_xxx); site tokens are rejected because a leaked editor credential must not mint bearer sessions.
|
|
6122
7707
|
*/
|
|
6123
7708
|
declare const createPreviewSession: <ThrowOnError extends boolean = false>(options: Options<CreatePreviewSessionData, ThrowOnError>) => RequestResult<CreatePreviewSessionResponses, CreatePreviewSessionErrors, ThrowOnError, "fields">;
|
|
7709
|
+
/**
|
|
7710
|
+
* List invoices (site token, or org key with site_id)
|
|
7711
|
+
*
|
|
7712
|
+
* Recorded rows only — never calls Stripe. Newest first. `include=aggregates` adds the outstanding / overdue / paid-this-month tiles.
|
|
7713
|
+
*/
|
|
7714
|
+
declare const listInvoices: <ThrowOnError extends boolean = false>(options?: Options<ListInvoicesData, ThrowOnError>) => RequestResult<ListInvoicesResponses, ListInvoicesErrors, ThrowOnError, "fields">;
|
|
7715
|
+
/**
|
|
7716
|
+
* Create and send an invoice (org key only)
|
|
7717
|
+
*
|
|
7718
|
+
* Creates a Stripe Invoice on the site's connected account for exactly the lines given, records it as an order (source 'invoice'), and emails the buyer OUR invoice email with a pay link. Tax follows the site's checkout rules (Stripe Tax when enabled — the customer then needs a billing address — else the declared inclusive rate for display, else none). Insert-first with a durable creation operation: a `201 created` carries the finished invoice; a `202 in_progress` means creation is finishing in the background — poll GET /invoices/{id}. Refuses near-duplicates (same recipient + amount inside 24h) unless allow_duplicate, and enforces per-site budgets (429).
|
|
7719
|
+
*/
|
|
7720
|
+
declare const createInvoice: <ThrowOnError extends boolean = false>(options: Options<CreateInvoiceData, ThrowOnError>) => RequestResult<CreateInvoiceResponses, CreateInvoiceErrors, ThrowOnError, "fields">;
|
|
7721
|
+
/**
|
|
7722
|
+
* Get one invoice
|
|
7723
|
+
*/
|
|
7724
|
+
declare const getInvoice: <ThrowOnError extends boolean = false>(options: Options<GetInvoiceData, ThrowOnError>) => RequestResult<GetInvoiceResponses, GetInvoiceErrors, ThrowOnError, "fields">;
|
|
7725
|
+
/**
|
|
7726
|
+
* Render the invoice email for a proposal (nothing is saved)
|
|
7727
|
+
*/
|
|
7728
|
+
declare const previewInvoice: <ThrowOnError extends boolean = false>(options: Options<PreviewInvoiceData, ThrowOnError>) => RequestResult<PreviewInvoiceResponses, PreviewInvoiceErrors, ThrowOnError, "fields">;
|
|
7729
|
+
/**
|
|
7730
|
+
* Preview the email using the invoice's current recorded details
|
|
7731
|
+
*/
|
|
7732
|
+
declare const getInvoicePreview: <ThrowOnError extends boolean = false>(options: Options<GetInvoicePreviewData, ThrowOnError>) => RequestResult<GetInvoicePreviewResponses, GetInvoicePreviewErrors, ThrowOnError, "fields">;
|
|
7733
|
+
/**
|
|
7734
|
+
* Void an open invoice (org key only), optionally reissuing a corrected one
|
|
7735
|
+
*/
|
|
7736
|
+
declare const voidInvoice: <ThrowOnError extends boolean = false>(options: Options<VoidInvoiceData, ThrowOnError>) => RequestResult<VoidInvoiceResponses, VoidInvoiceErrors, ThrowOnError, "fields">;
|
|
7737
|
+
/**
|
|
7738
|
+
* Send the invoice email again to the current recipient (org key only)
|
|
7739
|
+
*/
|
|
7740
|
+
declare const resendInvoice: <ThrowOnError extends boolean = false>(options: Options<ResendInvoiceData, ThrowOnError>) => RequestResult<ResendInvoiceResponses, ResendInvoiceErrors, ThrowOnError, "fields">;
|
|
7741
|
+
/**
|
|
7742
|
+
* Send a reminder now (org key only)
|
|
7743
|
+
*/
|
|
7744
|
+
declare const remindInvoice: <ThrowOnError extends boolean = false>(options: Options<RemindInvoiceData, ThrowOnError>) => RequestResult<RemindInvoiceResponses, RemindInvoiceErrors, ThrowOnError, "fields">;
|
|
7745
|
+
/**
|
|
7746
|
+
* Pause reminders until a date (org key only)
|
|
7747
|
+
*/
|
|
7748
|
+
declare const snoozeInvoice: <ThrowOnError extends boolean = false>(options: Options<SnoozeInvoiceData, ThrowOnError>) => RequestResult<SnoozeInvoiceResponses, SnoozeInvoiceErrors, ThrowOnError, "fields">;
|
|
7749
|
+
/**
|
|
7750
|
+
* Turn reminders off or on for one invoice, optionally with its own schedule (org key only)
|
|
7751
|
+
*/
|
|
7752
|
+
declare const setInvoiceReminders: <ThrowOnError extends boolean = false>(options: Options<SetInvoiceRemindersData, ThrowOnError>) => RequestResult<SetInvoiceRemindersResponses, SetInvoiceRemindersErrors, ThrowOnError, "fields">;
|
|
7753
|
+
/**
|
|
7754
|
+
* Record a payment made outside Stripe (org key only)
|
|
7755
|
+
*
|
|
7756
|
+
* Persists the intent, then marks the Stripe invoice paid out of band, then applies the payment locally. A buyer card payment that lands first wins and is never relabelled.
|
|
7757
|
+
*/
|
|
7758
|
+
declare const markInvoicePaid: <ThrowOnError extends boolean = false>(options: Options<MarkInvoicePaidData, ThrowOnError>) => RequestResult<MarkInvoicePaidResponses, MarkInvoicePaidErrors, ThrowOnError, "fields">;
|
|
7759
|
+
/**
|
|
7760
|
+
* Write an open invoice off (org key only) — reminders stop, the buyer is not emailed, a late payment still lands
|
|
7761
|
+
*/
|
|
7762
|
+
declare const markInvoiceUncollectible: <ThrowOnError extends boolean = false>(options: Options<MarkInvoiceUncollectibleData, ThrowOnError>) => RequestResult<MarkInvoiceUncollectibleResponses, MarkInvoiceUncollectibleErrors, ThrowOnError, "fields">;
|
|
7763
|
+
/**
|
|
7764
|
+
* Correct the recipient address (org key only) — delivery only unless also_update_customer
|
|
7765
|
+
*/
|
|
7766
|
+
declare const updateInvoiceRecipient: <ThrowOnError extends boolean = false>(options: Options<UpdateInvoiceRecipientData, ThrowOnError>) => RequestResult<UpdateInvoiceRecipientResponses, UpdateInvoiceRecipientErrors, ThrowOnError, "fields">;
|
|
7767
|
+
/**
|
|
7768
|
+
* Remember a customer's bill-to identity, name and language (org key only)
|
|
7769
|
+
*
|
|
7770
|
+
* Applies to future invoices; the Stripe Customer on the connected account is updated when one exists.
|
|
7771
|
+
*/
|
|
7772
|
+
declare const updateCustomerBilling: <ThrowOnError extends boolean = false>(options: Options<UpdateCustomerBillingData, ThrowOnError>) => RequestResult<UpdateCustomerBillingResponses, UpdateCustomerBillingErrors, ThrowOnError, "fields">;
|
|
7773
|
+
/**
|
|
7774
|
+
* The site's invoicing defaults and state (site token shorthand)
|
|
7775
|
+
*
|
|
7776
|
+
* Self-scoped by the site token — what the Invoices view reads to decide its empty state and banners.
|
|
7777
|
+
*/
|
|
7778
|
+
declare const getInvoiceSettingsWithSiteToken: <ThrowOnError extends boolean = false>(options?: Options<GetInvoiceSettingsWithSiteTokenData, ThrowOnError>) => RequestResult<GetInvoiceSettingsWithSiteTokenResponses, GetInvoiceSettingsWithSiteTokenErrors, ThrowOnError, "fields">;
|
|
7779
|
+
/**
|
|
7780
|
+
* The site's invoicing defaults and state
|
|
7781
|
+
*/
|
|
7782
|
+
declare const getInvoiceSettings: <ThrowOnError extends boolean = false>(options: Options<GetInvoiceSettingsData, ThrowOnError>) => RequestResult<GetInvoiceSettingsResponses, GetInvoiceSettingsErrors, ThrowOnError, "fields">;
|
|
7783
|
+
/**
|
|
7784
|
+
* Change the site's invoicing defaults (org key only): due days, reminder schedule, footer, language, timezone
|
|
7785
|
+
*/
|
|
7786
|
+
declare const updateInvoiceSettings: <ThrowOnError extends boolean = false>(options: Options<UpdateInvoiceSettingsData, ThrowOnError>) => RequestResult<UpdateInvoiceSettingsResponses, UpdateInvoiceSettingsErrors, ThrowOnError, "fields">;
|
|
7787
|
+
/**
|
|
7788
|
+
* Admin: set an invoicing budget override, block or unblock sending (org key only)
|
|
7789
|
+
*/
|
|
7790
|
+
declare const updateSiteInvoicing: <ThrowOnError extends boolean = false>(options: Options<UpdateSiteInvoicingData, ThrowOnError>) => RequestResult<UpdateSiteInvoicingResponses, UpdateSiteInvoicingErrors, ThrowOnError, "fields">;
|
|
7791
|
+
/**
|
|
7792
|
+
* List retainers (site token, or org key with ?site_id=)
|
|
7793
|
+
*/
|
|
7794
|
+
declare const listRetainers: <ThrowOnError extends boolean = false>(options?: Options<ListRetainersData, ThrowOnError>) => RequestResult<ListRetainersResponses, ListRetainersErrors, ThrowOnError, "fields">;
|
|
7795
|
+
/**
|
|
7796
|
+
* Create a retainer — a recurring invoice on the merchant's schedule (org key only)
|
|
7797
|
+
*
|
|
7798
|
+
* Inserts the retainer, then creates a Stripe subscription (send_invoice, no auto-charge) on the merchant's account. Each cycle becomes an unpaid invoice order sent with our email. 201 with the retainer, or 202 while Stripe is slow; `idempotency_key` makes a retry return the same retainer. Stripe Tax needs the customer's billing address up front.
|
|
7799
|
+
*/
|
|
7800
|
+
declare const createRetainer: <ThrowOnError extends boolean = false>(options: Options<CreateRetainerData, ThrowOnError>) => RequestResult<CreateRetainerResponses, CreateRetainerErrors, ThrowOnError, "fields">;
|
|
7801
|
+
/**
|
|
7802
|
+
* Get one retainer
|
|
7803
|
+
*/
|
|
7804
|
+
declare const getRetainer: <ThrowOnError extends boolean = false>(options: Options<GetRetainerData, ThrowOnError>) => RequestResult<GetRetainerResponses, GetRetainerErrors, ThrowOnError, "fields">;
|
|
7805
|
+
/**
|
|
7806
|
+
* Change a retainer's amount (from the next cycle), description or due terms (org key only)
|
|
7807
|
+
*/
|
|
7808
|
+
declare const updateRetainer: <ThrowOnError extends boolean = false>(options: Options<UpdateRetainerData, ThrowOnError>) => RequestResult<UpdateRetainerResponses, UpdateRetainerErrors, ThrowOnError, "fields">;
|
|
7809
|
+
/**
|
|
7810
|
+
* Waive the next cycle — nothing is owed for it; the schedule is unchanged (org key only)
|
|
7811
|
+
*/
|
|
7812
|
+
declare const skipNextRetainerCycle: <ThrowOnError extends boolean = false>(options: Options<SkipNextRetainerCycleData, ThrowOnError>) => RequestResult<SkipNextRetainerCycleResponses, SkipNextRetainerCycleErrors, ThrowOnError, "fields">;
|
|
7813
|
+
/**
|
|
7814
|
+
* Pause a retainer (merchant's pause; no cycles are billed until resumed) (org key only)
|
|
7815
|
+
*/
|
|
7816
|
+
declare const pauseRetainer: <ThrowOnError extends boolean = false>(options: Options<PauseRetainerData, ThrowOnError>) => RequestResult<PauseRetainerResponses, PauseRetainerErrors, ThrowOnError, "fields">;
|
|
7817
|
+
/**
|
|
7818
|
+
* Lift the merchant's pause; billing resumes only when no other reason (plan, suspension) remains (org key only)
|
|
7819
|
+
*/
|
|
7820
|
+
declare const resumeRetainer: <ThrowOnError extends boolean = false>(options: Options<ResumeRetainerData, ThrowOnError>) => RequestResult<ResumeRetainerResponses, ResumeRetainerErrors, ThrowOnError, "fields">;
|
|
7821
|
+
/**
|
|
7822
|
+
* End a retainer at the end of its current period; the open cycle stays payable (org key only)
|
|
7823
|
+
*/
|
|
7824
|
+
declare const cancelRetainer: <ThrowOnError extends boolean = false>(options: Options<CancelRetainerData, ThrowOnError>) => RequestResult<CancelRetainerResponses, CancelRetainerErrors, ThrowOnError, "fields">;
|
|
6124
7825
|
/**
|
|
6125
7826
|
* List all forms (site token)
|
|
6126
7827
|
*
|
|
@@ -6454,4 +8155,4 @@ declare const resolveManageLink: <ThrowOnError extends boolean = false>(options:
|
|
|
6454
8155
|
*/
|
|
6455
8156
|
declare const actOnManageLink: <ThrowOnError extends boolean = false>(options: Options<ActOnManageLinkData, ThrowOnError>) => RequestResult<ActOnManageLinkResponses, ActOnManageLinkErrors, ThrowOnError, "fields">;
|
|
6456
8157
|
|
|
6457
|
-
export { type AccountCancelSubscriptionData, type AccountCancelSubscriptionError, type AccountCancelSubscriptionErrors, type AccountCancelSubscriptionResponse, type AccountCancelSubscriptionResponses, type AccountCreatePortalSessionData, type AccountCreatePortalSessionError, type AccountCreatePortalSessionErrors, type AccountCreatePortalSessionResponse, type AccountCreatePortalSessionResponses, type AccountLoginData, type AccountLoginError, type AccountLoginErrors, type AccountLoginRequest, type AccountLoginResponse, type AccountLoginResponses, type AccountLoginResult, type AccountLogoutData, type AccountLogoutError, type AccountLogoutErrors, type AccountLogoutResponse, type AccountLogoutResponses, type AccountLogoutResult, type AccountManageCancelData, type AccountManageCancelError, type AccountManageCancelErrors, type AccountManageCancelResponse, type AccountManageCancelResponses, type AccountManageGetSubscriptionData, type AccountManageGetSubscriptionError, type AccountManageGetSubscriptionErrors, type AccountManageGetSubscriptionResponse, type AccountManageGetSubscriptionResponses, type AccountManagePortalSessionData, type AccountManagePortalSessionError, type AccountManagePortalSessionErrors, type AccountManagePortalSessionResponse, type AccountManagePortalSessionResponses, type AccountManageVerifyData, type AccountManageVerifyError, type AccountManageVerifyErrors, type AccountManageVerifyResponse, type AccountManageVerifyResponses, type AccountMeData, type AccountMeError, type AccountMeErrors, type AccountMeResponse, type AccountMeResponses, type AccountMeResult, type AccountReactivateSubscriptionData, type AccountReactivateSubscriptionError, type AccountReactivateSubscriptionErrors, type AccountReactivateSubscriptionResponse, type AccountReactivateSubscriptionResponses, type AccountSubscribeData, type AccountSubscribeError, type AccountSubscribeErrors, type AccountSubscribeRequest, type AccountSubscribeResponse, type AccountSubscribeResponses, type AccountUpdateSubscriptionAddressData, type AccountUpdateSubscriptionAddressError, type AccountUpdateSubscriptionAddressErrors, type AccountUpdateSubscriptionAddressResponse, type AccountUpdateSubscriptionAddressResponses, type AccountVerifyData, type AccountVerifyError, type AccountVerifyErrors, type AccountVerifyRequest, type AccountVerifyResponse, type AccountVerifyResponses, type AccountVerifyResult, type ActOnManageLinkData, type ActOnManageLinkError, type ActOnManageLinkErrors, type ActOnManageLinkResponse, type ActOnManageLinkResponses, type AdjustInventory, type AdjustVariantInventoryData, type AdjustVariantInventoryError, type AdjustVariantInventoryErrors, type AdjustVariantInventoryResponse, type AdjustVariantInventoryResponses, type AttachProductFileData, type AttachProductFileError, type AttachProductFileErrors, type AttachProductFileFromUrl, type AttachProductFileMultipart, type AttachProductFileResponse, type AttachProductFileResponses, type Attachment, type BusinessSummary, type CancelSubscriptionData, type CancelSubscriptionErrors, type CancelSubscriptionResponse, type CancelSubscriptionResponses, type CartCheckoutRequest, type CartConflict, type CartConflictItem, type CartSummaryRequest, type CartSummaryResult, type ChangedField, type CheckoutPauseRequest, type CheckoutPauseState, type CheckoutRequest, type CheckoutResult, type Client, type ClientOptions$1 as ClientConfig, type ClientOptions, type Config, type CreateCartCheckoutData, type CreateCartCheckoutError, type CreateCartCheckoutErrors, type CreateCartCheckoutResponse, type CreateCartCheckoutResponses, type CreateCheckoutData, type CreateCheckoutError, type CreateCheckoutErrors, type CreateCheckoutResponse, type CreateCheckoutResponses, type CreateCustomer, type CreateCustomerData, type CreateCustomerError, type CreateCustomerErrors, type CreateCustomerResponse, type CreateCustomerResponses, type CreateEventDestination, type CreateEventDestinationData, type CreateEventDestinationError, type CreateEventDestinationErrors, type CreateEventDestinationResponse, type CreateEventDestinationResponses, type CreateEventDestinationWithSiteTokenData, type CreateEventDestinationWithSiteTokenError, type CreateEventDestinationWithSiteTokenErrors, type CreateEventDestinationWithSiteTokenResponse, type CreateEventDestinationWithSiteTokenResponses, type CreateForm, type CreateFormData, type CreateFormError, type CreateFormErrors, type CreateFormResponse, type CreateFormResponses, type CreateFormWithSiteTokenData, type CreateFormWithSiteTokenError, type CreateFormWithSiteTokenErrors, type CreateFormWithSiteTokenResponse, type CreateFormWithSiteTokenResponses, type CreateMultiItemTestOrder, type CreateMultiItemTestOrderData, type CreateMultiItemTestOrderError, type CreateMultiItemTestOrderErrors, type CreateMultiItemTestOrderResponse, type CreateMultiItemTestOrderResponses, type CreateOption, type CreateOptionData, type CreateOptionError, type CreateOptionErrors, type CreateOptionResponse, type CreateOptionResponses, type CreatePreviewSession, type CreatePreviewSessionData, type CreatePreviewSessionError, type CreatePreviewSessionErrors, type CreatePreviewSessionResponse, type CreatePreviewSessionResponses, type CreateProduct, type CreateProductData, type CreateProductError, type CreateProductErrors, type CreateProductResponse, type CreateProductResponses, type CreateProductWithSiteTokenData, type CreateProductWithSiteTokenError, type CreateProductWithSiteTokenErrors, type CreateProductWithSiteTokenResponse, type CreateProductWithSiteTokenResponses, type CreateSite, type CreateSiteData, type CreateSiteError, type CreateSiteErrors, type CreateSiteResponse, type CreateSiteResponses, type CreateTestOrder, type CreateTestOrderData, type CreateTestOrderError, type CreateTestOrderErrors, type CreateTestOrderResponse, type CreateTestOrderResponses, type CreateTestSubscription, type CreateTestSubscriptionData, type CreateTestSubscriptionError, type CreateTestSubscriptionErrors, type CreateTestSubscriptionResponse, type CreateTestSubscriptionResponses, type CreateVariant, type CreateVariantData, type CreateVariantError, type CreateVariantErrors, type CreateVariantResponse, type CreateVariantResponses, type CurrencyRestatement, type CurrencyTotals, type Customer, type CustomerAddress, type CustomerDetail, type CustomersList, type DeleteEventDestinationData, type DeleteEventDestinationError, type DeleteEventDestinationErrors, type DeleteEventDestinationResponse, type DeleteEventDestinationResponses, type DeleteEventDestinationWithSiteTokenData, type DeleteEventDestinationWithSiteTokenError, type DeleteEventDestinationWithSiteTokenErrors, type DeleteEventDestinationWithSiteTokenResponse, type DeleteEventDestinationWithSiteTokenResponses, type DeleteFormData, type DeleteFormError, type DeleteFormErrors, type DeleteFormResponse, type DeleteFormResponses, type DeleteOptionData, type DeleteOptionError, type DeleteOptionErrors, type DeleteOptionResponse, type DeleteOptionResponses, type DeleteProductData, type DeleteProductError, type DeleteProductErrors, type DeleteProductResponse, type DeleteProductResponses, type DeleteSiteData, type DeleteSiteError, type DeleteSiteErrors, type DeleteSiteResponse, type DeleteSiteResponses, type DeleteSubmissionData, type DeleteSubmissionError, type DeleteSubmissionErrors, type DeleteSubmissionResponse, type DeleteSubmissionResponses, type DeleteVariantData, type DeleteVariantError, type DeleteVariantErrors, type DeleteVariantResponse, type DeleteVariantResponses, type DownloadAttachmentData, type DownloadAttachmentError, type DownloadAttachmentErrors, type DownloadAttachmentResponses, type DownloadFileData, type DownloadFileError, type DownloadFileErrors, type DownloadFileResponse, type DownloadFileResponses, type Error, type EventDeliveriesList, type EventDelivery, type EventDestination, type EventDestinationSecret, type EventDestinationsList, type Form, type FormsList, type GenerateVariants, type GenerateVariantsData, type GenerateVariantsError, type GenerateVariantsErrors, type GenerateVariantsResponse, type GenerateVariantsResponses, type GenerateVariantsResult, type GeoSuggestion, type GetBusinessSummaryData, type GetBusinessSummaryErrors, type GetBusinessSummaryResponse, type GetBusinessSummaryResponses, type GetCartSummaryData, type GetCartSummaryError, type GetCartSummaryErrors, type GetCartSummaryResponse, type GetCartSummaryResponses, type GetCustomerData, type GetCustomerError, type GetCustomerErrors, type GetCustomerResponse, type GetCustomerResponses, type GetEventDestinationData, type GetEventDestinationError, type GetEventDestinationErrors, type GetEventDestinationResponse, type GetEventDestinationResponses, type GetEventDestinationSecretData, type GetEventDestinationSecretError, type GetEventDestinationSecretErrors, type GetEventDestinationSecretResponse, type GetEventDestinationSecretResponses, type GetEventDestinationSecretWithSiteTokenData, type GetEventDestinationSecretWithSiteTokenError, type GetEventDestinationSecretWithSiteTokenErrors, type GetEventDestinationSecretWithSiteTokenResponse, type GetEventDestinationSecretWithSiteTokenResponses, type GetFormData, type GetFormError, type GetFormErrors, type GetFormResponse, type GetFormResponses, type GetGeoData, type GetGeoResponse, type GetGeoResponses, type GetNextPayoutData, type GetNextPayoutErrors, type GetNextPayoutResponse, type GetNextPayoutResponses, type GetOrderData, type GetOrderError, type GetOrderErrors, type GetOrderResponse, type GetOrderResponses, type GetOrderSessionData, type GetOrderSessionError, type GetOrderSessionErrors, type GetOrderSessionResponse, type GetOrderSessionResponses, type GetPaymentsStatusData, type GetPaymentsStatusError, type GetPaymentsStatusErrors, type GetPaymentsStatusResponse, type GetPaymentsStatusResponses, type GetPersonData, type GetPersonErrors, type GetPersonResponse, type GetPersonResponses, type GetProductData, type GetProductError, type GetProductErrors, type GetProductResponse, type GetProductResponses, type GetPublicProductData, type GetPublicProductError, type GetPublicProductErrors, type GetPublicProductResponse, type GetPublicProductResponses, type GetSalesSummaryData, type GetSalesSummaryErrors, type GetSalesSummaryResponse, type GetSalesSummaryResponses, type GetSiteCheckoutPauseData, type GetSiteCheckoutPauseError, type GetSiteCheckoutPauseErrors, type GetSiteCheckoutPauseResponse, type GetSiteCheckoutPauseResponses, type GetSiteData, type GetSiteError, type GetSiteErrors, type GetSiteResponse, type GetSiteResponses, type GetSubmissionData, type GetSubmissionError, type GetSubmissionErrors, type GetSubmissionResponse, type GetSubmissionResponses, type Inventory, type InventoryInput, type ListCustomersData, type ListCustomersError, type ListCustomersErrors, type ListCustomersResponse, type ListCustomersResponses, type ListEventDeliveriesData, type ListEventDeliveriesError, type ListEventDeliveriesErrors, type ListEventDeliveriesResponse, type ListEventDeliveriesResponses, type ListEventDeliveriesWithSiteTokenData, type ListEventDeliveriesWithSiteTokenError, type ListEventDeliveriesWithSiteTokenErrors, type ListEventDeliveriesWithSiteTokenResponse, type ListEventDeliveriesWithSiteTokenResponses, type ListEventDestinationsData, type ListEventDestinationsError, type ListEventDestinationsErrors, type ListEventDestinationsResponse, type ListEventDestinationsResponses, type ListEventDestinationsWithSiteTokenData, type ListEventDestinationsWithSiteTokenError, type ListEventDestinationsWithSiteTokenErrors, type ListEventDestinationsWithSiteTokenResponse, type ListEventDestinationsWithSiteTokenResponses, type ListFormsData, type ListFormsError, type ListFormsErrors, type ListFormsResponse, type ListFormsResponses, type ListFormsWithSiteTokenData, type ListFormsWithSiteTokenError, type ListFormsWithSiteTokenErrors, type ListFormsWithSiteTokenResponse, type ListFormsWithSiteTokenResponses, type ListOrdersWithSiteTokenData, type ListOrdersWithSiteTokenError, type ListOrdersWithSiteTokenErrors, type ListOrdersWithSiteTokenResponse, type ListOrdersWithSiteTokenResponses, type ListPeopleData, type ListPeopleErrors, type ListPeopleResponse, type ListPeopleResponses, type ListProductsData, type ListProductsError, type ListProductsErrors, type ListProductsResponse, type ListProductsResponses, type ListProductsWithSiteTokenData, type ListProductsWithSiteTokenError, type ListProductsWithSiteTokenErrors, type ListProductsWithSiteTokenResponse, type ListProductsWithSiteTokenResponses, type ListSitesData, type ListSitesError, type ListSitesErrors, type ListSitesResponse, type ListSitesResponses, type ListSubmissionsData, type ListSubmissionsError, type ListSubmissionsErrors, type ListSubmissionsResponse, type ListSubmissionsResponses, type ListSubscriptionsData, type ListSubscriptionsErrors, type ListSubscriptionsResponse, type ListSubscriptionsResponses, type ManageCancelResult, type ManageLinkAction, type ManageVerifyRequest, type ManageVerifyResult, type ManagedSubscription, type ManagedSubscriptionResult, type NeedsAttentionItem, type NestedOptionInput, type NestedVariantInput, type NextPayout, type Option, type Options, type Order, type OrderCustomer, type OrderFulfillmentRequest, type OrderSessionStatus, type OrdersList, type PauseSiteCheckoutData, type PauseSiteCheckoutError, type PauseSiteCheckoutErrors, type PauseSiteCheckoutResponse, type PauseSiteCheckoutResponses, type PaymentsStatus, type PeopleList, type PersonDetail, type PersonRow, type PortalSessionResult, type PreviewSessionResult, type Product, type ProductDetail, type ProductFulfillment, type ProductFulfillmentInput, type ProductSubscriptionConfig, type ProductsList, type PublicOption, type PublicProduct, type PublicSubscription, type PublicSubscriptionPlan, type PublicVariant, type ReactivateSiteSubscriptionsTeardownData, type ReactivateSiteSubscriptionsTeardownError, type ReactivateSiteSubscriptionsTeardownErrors, type ReactivateSiteSubscriptionsTeardownResponse, type ReactivateSiteSubscriptionsTeardownResponses, type ReconcileOptionInput, type ReconcileOptionValueInput, type ReconcileVariantInput, type RefundOrder, type RefundOrderData, type RefundOrderError, type RefundOrderErrors, type RefundOrderResponse, type RefundOrderResponses, type RefundResult, type ResendOrderReceiptData, type ResendOrderReceiptError, type ResendOrderReceiptErrors, type ResendOrderReceiptResponse, type ResendOrderReceiptResponses, type ResendReceiptResult, type ResetOrderDownloadsData, type ResetOrderDownloadsError, type ResetOrderDownloadsErrors, type ResetOrderDownloadsResponse, type ResetOrderDownloadsResponses, type ResetWebhookEventData, type ResetWebhookEventError, type ResetWebhookEventErrors, type ResetWebhookEventResponse, type ResetWebhookEventResponses, type ResolveManageLinkData, type ResolveManageLinkError, type ResolveManageLinkErrors, type ResolveManageLinkResponse, type ResolveManageLinkResponses, type RetryEventDeliveryData, type RetryEventDeliveryError, type RetryEventDeliveryErrors, type RetryEventDeliveryResponse, type RetryEventDeliveryResponses, type RetryEventDeliveryWithSiteTokenData, type RetryEventDeliveryWithSiteTokenError, type RetryEventDeliveryWithSiteTokenErrors, type RetryEventDeliveryWithSiteTokenResponse, type RetryEventDeliveryWithSiteTokenResponses, type RevokeCustomerAccessData, type RevokeCustomerAccessError, type RevokeCustomerAccessErrors, type RevokeCustomerAccessResponse, type RevokeCustomerAccessResponses, type RevokeCustomerAccessResult, type RotateEventDestinationSecretData, type RotateEventDestinationSecretError, type RotateEventDestinationSecretErrors, type RotateEventDestinationSecretResponse, type RotateEventDestinationSecretResponses, type RotateEventDestinationSecretWithSiteTokenData, type RotateEventDestinationSecretWithSiteTokenError, type RotateEventDestinationSecretWithSiteTokenErrors, type RotateEventDestinationSecretWithSiteTokenResponse, type RotateEventDestinationSecretWithSiteTokenResponses, type SalesSummary, type SalesSummaryProductRow, type SalesSummarySeriesEntry, type SetInventory, type SetOrderFulfillmentData, type SetOrderFulfillmentErrors, type SetOrderFulfillmentResponse, type SetOrderFulfillmentResponses, type SetProductSubscription, type SetProductSubscriptionData, type SetProductSubscriptionError, type SetProductSubscriptionErrors, type SetProductSubscriptionResponse, type SetProductSubscriptionResponses, type SetProductVariants, type SetProductVariantsConflict, type SetProductVariantsData, type SetProductVariantsError, type SetProductVariantsErrors, type SetProductVariantsResponse, type SetProductVariantsResponses, type SetProductVariantsResult, type SetVariantInventoryData, type SetVariantInventoryError, type SetVariantInventoryErrors, type SetVariantInventoryResponse, type SetVariantInventoryResponses, type SettledTotals, type ShippingOptionUnavailable, type ShippingRateInput, type Site, type SiteAccountRoute, type SiteDomains, type SitePayments, type SiteWithRestatement, type SiteWithToken, type SitesList, type Submission, type SubmissionMetadata, type SubmissionsList, type SubscriberActionResult, type SubscriberSubscription, type SubscriptionPlan, type SubscriptionPlanInput, type SubscriptionSummary, type SubscriptionsList, type SubscriptionsReactivateBody, type SubscriptionsReactivateResult, type SubscriptionsTeardownBody, type SubscriptionsTeardownResult, type SummaryPeriod, type TeardownReason, type TeardownSiteSubscriptionsData, type TeardownSiteSubscriptionsError, type TeardownSiteSubscriptionsErrors, type TeardownSiteSubscriptionsResponse, type TeardownSiteSubscriptionsResponses, type TestOrderResult, type TestShippingAddress, type TestSubscriptionResult, type UpdateCustomer, type UpdateCustomerData, type UpdateCustomerError, type UpdateCustomerErrors, type UpdateCustomerResponse, type UpdateCustomerResponses, type UpdateEventDestination, type UpdateEventDestinationData, type UpdateEventDestinationError, type UpdateEventDestinationErrors, type UpdateEventDestinationResponse, type UpdateEventDestinationResponses, type UpdateEventDestinationWithSiteTokenData, type UpdateEventDestinationWithSiteTokenError, type UpdateEventDestinationWithSiteTokenErrors, type UpdateEventDestinationWithSiteTokenResponse, type UpdateEventDestinationWithSiteTokenResponses, type UpdateForm, type UpdateFormData, type UpdateFormError, type UpdateFormErrors, type UpdateFormResponse, type UpdateFormResponses, type UpdateOption, type UpdateOptionData, type UpdateOptionError, type UpdateOptionErrors, type UpdateOptionResponse, type UpdateOptionResponses, type UpdateProduct, type UpdateProductData, type UpdateProductError, type UpdateProductErrors, type UpdateProductResponse, type UpdateProductResponses, type UpdateSite, type UpdateSiteAccountRoute, type UpdateSiteAccountRouteData, type UpdateSiteAccountRouteError, type UpdateSiteAccountRouteErrors, type UpdateSiteAccountRouteResponse, type UpdateSiteAccountRouteResponses, type UpdateSiteData, type UpdateSiteDomains, type UpdateSiteDomainsData, type UpdateSiteDomainsError, type UpdateSiteDomainsErrors, type UpdateSiteDomainsResponse, type UpdateSiteDomainsResponses, type UpdateSiteError, type UpdateSiteErrors, type UpdateSitePayments, type UpdateSitePaymentsData, type UpdateSitePaymentsError, type UpdateSitePaymentsErrors, type UpdateSitePaymentsResponse, type UpdateSitePaymentsResponses, type UpdateSiteResponse, type UpdateSiteResponses, type UpdateSubscriptionAddressRequest, type UpdateVariant, type UpdateVariantData, type UpdateVariantError, type UpdateVariantErrors, type UpdateVariantResponse, type UpdateVariantResponses, type Variant, type VariantOptionValue, type WebhookEventResetResult, accountCancelSubscription, accountCreatePortalSession, accountLogin, accountLogout, accountManageCancel, accountManageGetSubscription, accountManagePortalSession, accountManageVerify, accountMe, accountReactivateSubscription, accountSubscribe, accountUpdateSubscriptionAddress, accountVerify, actOnManageLink, adjustVariantInventory, attachProductFile, cancelSubscription, createCartCheckout, createCheckout, createClient, createConfig, createCustomer, createEventDestination, createEventDestinationWithSiteToken, createForm, createFormWithSiteToken, createMultiItemTestOrder, createOption, createPreviewSession, createProduct, createProductWithSiteToken, createSite, createTestOrder, createTestSubscription, createVariant, deleteEventDestination, deleteEventDestinationWithSiteToken, deleteForm, deleteOption, deleteProduct, deleteSite, deleteSubmission, deleteVariant, downloadAttachment, downloadFile, generateVariants, getBusinessSummary, getCartSummary, getCustomer, getEventDestination, getEventDestinationSecret, getEventDestinationSecretWithSiteToken, getForm, getGeo, getNextPayout, getOrder, getOrderSession, getPaymentsStatus, getPerson, getProduct, getPublicProduct, getSalesSummary, getSite, getSiteCheckoutPause, getSubmission, listCustomers, listEventDeliveries, listEventDeliveriesWithSiteToken, listEventDestinations, listEventDestinationsWithSiteToken, listForms, listFormsWithSiteToken, listOrdersWithSiteToken, listPeople, listProducts, listProductsWithSiteToken, listSites, listSubmissions, listSubscriptions, pauseSiteCheckout, reactivateSiteSubscriptionsTeardown, refundOrder, resendOrderReceipt, resetOrderDownloads, resetWebhookEvent, resolveManageLink, retryEventDelivery, retryEventDeliveryWithSiteToken, revokeCustomerAccess, rotateEventDestinationSecret, rotateEventDestinationSecretWithSiteToken, setOrderFulfillment, setProductSubscription, setProductVariants, setVariantInventory, teardownSiteSubscriptions, updateCustomer, updateEventDestination, updateEventDestinationWithSiteToken, updateForm, updateOption, updateProduct, updateSite, updateSiteAccountRoute, updateSiteDomains, updateSitePayments, updateVariant };
|
|
8158
|
+
export { type AccountCancelSubscriptionData, type AccountCancelSubscriptionError, type AccountCancelSubscriptionErrors, type AccountCancelSubscriptionResponse, type AccountCancelSubscriptionResponses, type AccountCreatePortalSessionData, type AccountCreatePortalSessionError, type AccountCreatePortalSessionErrors, type AccountCreatePortalSessionResponse, type AccountCreatePortalSessionResponses, type AccountLoginData, type AccountLoginError, type AccountLoginErrors, type AccountLoginRequest, type AccountLoginResponse, type AccountLoginResponses, type AccountLoginResult, type AccountLogoutData, type AccountLogoutError, type AccountLogoutErrors, type AccountLogoutResponse, type AccountLogoutResponses, type AccountLogoutResult, type AccountManageCancelData, type AccountManageCancelError, type AccountManageCancelErrors, type AccountManageCancelResponse, type AccountManageCancelResponses, type AccountManageGetSubscriptionData, type AccountManageGetSubscriptionError, type AccountManageGetSubscriptionErrors, type AccountManageGetSubscriptionResponse, type AccountManageGetSubscriptionResponses, type AccountManagePortalSessionData, type AccountManagePortalSessionError, type AccountManagePortalSessionErrors, type AccountManagePortalSessionResponse, type AccountManagePortalSessionResponses, type AccountManageVerifyData, type AccountManageVerifyError, type AccountManageVerifyErrors, type AccountManageVerifyResponse, type AccountManageVerifyResponses, type AccountMeData, type AccountMeError, type AccountMeErrors, type AccountMeResponse, type AccountMeResponses, type AccountMeResult, type AccountReactivateSubscriptionData, type AccountReactivateSubscriptionError, type AccountReactivateSubscriptionErrors, type AccountReactivateSubscriptionResponse, type AccountReactivateSubscriptionResponses, type AccountSubscribeData, type AccountSubscribeError, type AccountSubscribeErrors, type AccountSubscribeRequest, type AccountSubscribeResponse, type AccountSubscribeResponses, type AccountUpdateSubscriptionAddressData, type AccountUpdateSubscriptionAddressError, type AccountUpdateSubscriptionAddressErrors, type AccountUpdateSubscriptionAddressResponse, type AccountUpdateSubscriptionAddressResponses, type AccountVerifyData, type AccountVerifyError, type AccountVerifyErrors, type AccountVerifyRequest, type AccountVerifyResponse, type AccountVerifyResponses, type AccountVerifyResult, type ActOnManageLinkData, type ActOnManageLinkError, type ActOnManageLinkErrors, type ActOnManageLinkResponse, type ActOnManageLinkResponses, type AdjustInventory, type AdjustVariantInventoryData, type AdjustVariantInventoryError, type AdjustVariantInventoryErrors, type AdjustVariantInventoryResponse, type AdjustVariantInventoryResponses, type AttachProductFileData, type AttachProductFileError, type AttachProductFileErrors, type AttachProductFileFromUrl, type AttachProductFileMultipart, type AttachProductFileResponse, type AttachProductFileResponses, type Attachment, type BusinessSummary, type CancelRetainerData, type CancelRetainerError, type CancelRetainerErrors, type CancelRetainerResponse, type CancelRetainerResponses, type CancelSubscriptionData, type CancelSubscriptionErrors, type CancelSubscriptionResponse, type CancelSubscriptionResponses, type CartCheckoutRequest, type CartConflict, type CartConflictItem, type CartSummaryRequest, type CartSummaryResult, type ChangedField, type CheckoutPauseRequest, type CheckoutPauseState, type CheckoutRequest, type CheckoutResult, type Client, type ClientOptions$1 as ClientConfig, type ClientOptions, type Config, type CreateCartCheckoutData, type CreateCartCheckoutError, type CreateCartCheckoutErrors, type CreateCartCheckoutResponse, type CreateCartCheckoutResponses, type CreateCheckoutData, type CreateCheckoutError, type CreateCheckoutErrors, type CreateCheckoutResponse, type CreateCheckoutResponses, type CreateCustomer, type CreateCustomerData, type CreateCustomerError, type CreateCustomerErrors, type CreateCustomerResponse, type CreateCustomerResponses, type CreateEventDestination, type CreateEventDestinationData, type CreateEventDestinationError, type CreateEventDestinationErrors, type CreateEventDestinationResponse, type CreateEventDestinationResponses, type CreateEventDestinationWithSiteTokenData, type CreateEventDestinationWithSiteTokenError, type CreateEventDestinationWithSiteTokenErrors, type CreateEventDestinationWithSiteTokenResponse, type CreateEventDestinationWithSiteTokenResponses, type CreateForm, type CreateFormData, type CreateFormError, type CreateFormErrors, type CreateFormResponse, type CreateFormResponses, type CreateFormWithSiteTokenData, type CreateFormWithSiteTokenError, type CreateFormWithSiteTokenErrors, type CreateFormWithSiteTokenResponse, type CreateFormWithSiteTokenResponses, type CreateInvoice, type CreateInvoiceData, type CreateInvoiceError, type CreateInvoiceErrors, type CreateInvoiceLine, type CreateInvoiceResponse, type CreateInvoiceResponses, type CreateInvoiceResult, type CreateMultiItemTestOrder, type CreateMultiItemTestOrderData, type CreateMultiItemTestOrderError, type CreateMultiItemTestOrderErrors, type CreateMultiItemTestOrderResponse, type CreateMultiItemTestOrderResponses, type CreateOption, type CreateOptionData, type CreateOptionError, type CreateOptionErrors, type CreateOptionResponse, type CreateOptionResponses, type CreatePreviewSession, type CreatePreviewSessionData, type CreatePreviewSessionError, type CreatePreviewSessionErrors, type CreatePreviewSessionResponse, type CreatePreviewSessionResponses, type CreateProduct, type CreateProductData, type CreateProductError, type CreateProductErrors, type CreateProductResponse, type CreateProductResponses, type CreateProductWithSiteTokenData, type CreateProductWithSiteTokenError, type CreateProductWithSiteTokenErrors, type CreateProductWithSiteTokenResponse, type CreateProductWithSiteTokenResponses, type CreateRetainer, type CreateRetainerData, type CreateRetainerError, type CreateRetainerErrors, type CreateRetainerResponse, type CreateRetainerResponses, type CreateRetainerResult, type CreateSite, type CreateSiteData, type CreateSiteError, type CreateSiteErrors, type CreateSiteResponse, type CreateSiteResponses, type CreateTestOrder, type CreateTestOrderData, type CreateTestOrderError, type CreateTestOrderErrors, type CreateTestOrderResponse, type CreateTestOrderResponses, type CreateTestSubscription, type CreateTestSubscriptionData, type CreateTestSubscriptionError, type CreateTestSubscriptionErrors, type CreateTestSubscriptionResponse, type CreateTestSubscriptionResponses, type CreateVariant, type CreateVariantData, type CreateVariantError, type CreateVariantErrors, type CreateVariantResponse, type CreateVariantResponses, type CurrencyRestatement, type CurrencyTotals, type Customer, type CustomerAddress, type CustomerBilling, type CustomerDetail, type CustomersList, type DeleteEventDestinationData, type DeleteEventDestinationError, type DeleteEventDestinationErrors, type DeleteEventDestinationResponse, type DeleteEventDestinationResponses, type DeleteEventDestinationWithSiteTokenData, type DeleteEventDestinationWithSiteTokenError, type DeleteEventDestinationWithSiteTokenErrors, type DeleteEventDestinationWithSiteTokenResponse, type DeleteEventDestinationWithSiteTokenResponses, type DeleteFormData, type DeleteFormError, type DeleteFormErrors, type DeleteFormResponse, type DeleteFormResponses, type DeleteOptionData, type DeleteOptionError, type DeleteOptionErrors, type DeleteOptionResponse, type DeleteOptionResponses, type DeleteProductData, type DeleteProductError, type DeleteProductErrors, type DeleteProductResponse, type DeleteProductResponses, type DeleteSiteData, type DeleteSiteError, type DeleteSiteErrors, type DeleteSiteResponse, type DeleteSiteResponses, type DeleteSubmissionData, type DeleteSubmissionError, type DeleteSubmissionErrors, type DeleteSubmissionResponse, type DeleteSubmissionResponses, type DeleteVariantData, type DeleteVariantError, type DeleteVariantErrors, type DeleteVariantResponse, type DeleteVariantResponses, type DownloadAttachmentData, type DownloadAttachmentError, type DownloadAttachmentErrors, type DownloadAttachmentResponses, type DownloadFileData, type DownloadFileError, type DownloadFileErrors, type DownloadFileResponse, type DownloadFileResponses, type Error, type EventDeliveriesList, type EventDelivery, type EventDestination, type EventDestinationSecret, type EventDestinationsList, type Form, type FormsList, type GenerateVariants, type GenerateVariantsData, type GenerateVariantsError, type GenerateVariantsErrors, type GenerateVariantsResponse, type GenerateVariantsResponses, type GenerateVariantsResult, type GeoSuggestion, type GetBusinessSummaryData, type GetBusinessSummaryErrors, type GetBusinessSummaryResponse, type GetBusinessSummaryResponses, type GetCartSummaryData, type GetCartSummaryError, type GetCartSummaryErrors, type GetCartSummaryResponse, type GetCartSummaryResponses, type GetCustomerData, type GetCustomerError, type GetCustomerErrors, type GetCustomerResponse, type GetCustomerResponses, type GetEventDestinationData, type GetEventDestinationError, type GetEventDestinationErrors, type GetEventDestinationResponse, type GetEventDestinationResponses, type GetEventDestinationSecretData, type GetEventDestinationSecretError, type GetEventDestinationSecretErrors, type GetEventDestinationSecretResponse, type GetEventDestinationSecretResponses, type GetEventDestinationSecretWithSiteTokenData, type GetEventDestinationSecretWithSiteTokenError, type GetEventDestinationSecretWithSiteTokenErrors, type GetEventDestinationSecretWithSiteTokenResponse, type GetEventDestinationSecretWithSiteTokenResponses, type GetFormData, type GetFormError, type GetFormErrors, type GetFormResponse, type GetFormResponses, type GetGeoData, type GetGeoResponse, type GetGeoResponses, type GetInvoiceData, type GetInvoiceError, type GetInvoiceErrors, type GetInvoicePreviewData, type GetInvoicePreviewError, type GetInvoicePreviewErrors, type GetInvoicePreviewResponse, type GetInvoicePreviewResponses, type GetInvoiceResponse, type GetInvoiceResponses, type GetInvoiceSettingsData, type GetInvoiceSettingsError, type GetInvoiceSettingsErrors, type GetInvoiceSettingsResponse, type GetInvoiceSettingsResponses, type GetInvoiceSettingsWithSiteTokenData, type GetInvoiceSettingsWithSiteTokenError, type GetInvoiceSettingsWithSiteTokenErrors, type GetInvoiceSettingsWithSiteTokenResponse, type GetInvoiceSettingsWithSiteTokenResponses, type GetNextPayoutData, type GetNextPayoutErrors, type GetNextPayoutResponse, type GetNextPayoutResponses, type GetOrderData, type GetOrderError, type GetOrderErrors, type GetOrderResponse, type GetOrderResponses, type GetOrderSessionData, type GetOrderSessionError, type GetOrderSessionErrors, type GetOrderSessionResponse, type GetOrderSessionResponses, type GetPaymentsStatusData, type GetPaymentsStatusError, type GetPaymentsStatusErrors, type GetPaymentsStatusResponse, type GetPaymentsStatusResponses, type GetPersonData, type GetPersonErrors, type GetPersonResponse, type GetPersonResponses, type GetProductData, type GetProductError, type GetProductErrors, type GetProductResponse, type GetProductResponses, type GetPublicProductData, type GetPublicProductError, type GetPublicProductErrors, type GetPublicProductResponse, type GetPublicProductResponses, type GetRetainerData, type GetRetainerError, type GetRetainerErrors, type GetRetainerResponse, type GetRetainerResponses, type GetSalesSummaryData, type GetSalesSummaryErrors, type GetSalesSummaryResponse, type GetSalesSummaryResponses, type GetSiteCheckoutPauseData, type GetSiteCheckoutPauseError, type GetSiteCheckoutPauseErrors, type GetSiteCheckoutPauseResponse, type GetSiteCheckoutPauseResponses, type GetSiteData, type GetSiteError, type GetSiteErrors, type GetSiteResponse, type GetSiteResponses, type GetSubmissionData, type GetSubmissionError, type GetSubmissionErrors, type GetSubmissionResponse, type GetSubmissionResponses, type Inventory, type InventoryInput, type Invoice, type InvoiceAggregates, type InvoiceBillTo, type InvoiceError, type InvoiceLineItem, type InvoicePreview, type InvoiceSettings, type InvoiceSiteBody, type InvoicesList, type ListCustomersData, type ListCustomersError, type ListCustomersErrors, type ListCustomersResponse, type ListCustomersResponses, type ListEventDeliveriesData, type ListEventDeliveriesError, type ListEventDeliveriesErrors, type ListEventDeliveriesResponse, type ListEventDeliveriesResponses, type ListEventDeliveriesWithSiteTokenData, type ListEventDeliveriesWithSiteTokenError, type ListEventDeliveriesWithSiteTokenErrors, type ListEventDeliveriesWithSiteTokenResponse, type ListEventDeliveriesWithSiteTokenResponses, type ListEventDestinationsData, type ListEventDestinationsError, type ListEventDestinationsErrors, type ListEventDestinationsResponse, type ListEventDestinationsResponses, type ListEventDestinationsWithSiteTokenData, type ListEventDestinationsWithSiteTokenError, type ListEventDestinationsWithSiteTokenErrors, type ListEventDestinationsWithSiteTokenResponse, type ListEventDestinationsWithSiteTokenResponses, type ListFormsData, type ListFormsError, type ListFormsErrors, type ListFormsResponse, type ListFormsResponses, type ListFormsWithSiteTokenData, type ListFormsWithSiteTokenError, type ListFormsWithSiteTokenErrors, type ListFormsWithSiteTokenResponse, type ListFormsWithSiteTokenResponses, type ListInvoicesData, type ListInvoicesError, type ListInvoicesErrors, type ListInvoicesResponse, type ListInvoicesResponses, type ListOrdersWithSiteTokenData, type ListOrdersWithSiteTokenError, type ListOrdersWithSiteTokenErrors, type ListOrdersWithSiteTokenResponse, type ListOrdersWithSiteTokenResponses, type ListPeopleData, type ListPeopleErrors, type ListPeopleResponse, type ListPeopleResponses, type ListProductsData, type ListProductsError, type ListProductsErrors, type ListProductsResponse, type ListProductsResponses, type ListProductsWithSiteTokenData, type ListProductsWithSiteTokenError, type ListProductsWithSiteTokenErrors, type ListProductsWithSiteTokenResponse, type ListProductsWithSiteTokenResponses, type ListRetainersData, type ListRetainersError, type ListRetainersErrors, type ListRetainersResponse, type ListRetainersResponses, type ListSitesData, type ListSitesError, type ListSitesErrors, type ListSitesResponse, type ListSitesResponses, type ListSubmissionsData, type ListSubmissionsError, type ListSubmissionsErrors, type ListSubmissionsResponse, type ListSubmissionsResponses, type ListSubscriptionsData, type ListSubscriptionsErrors, type ListSubscriptionsResponse, type ListSubscriptionsResponses, type ManageCancelResult, type ManageLinkAction, type ManageVerifyRequest, type ManageVerifyResult, type ManagedSubscription, type ManagedSubscriptionResult, type MarkInvoicePaid, type MarkInvoicePaidData, type MarkInvoicePaidError, type MarkInvoicePaidErrors, type MarkInvoicePaidResponse, type MarkInvoicePaidResponses, type MarkInvoicePaidResult, type MarkInvoiceUncollectibleData, type MarkInvoiceUncollectibleError, type MarkInvoiceUncollectibleErrors, type MarkInvoiceUncollectibleResponse, type MarkInvoiceUncollectibleResponses, type NeedsAttentionItem, type NestedOptionInput, type NestedVariantInput, type NextPayout, type Option, type Options, type Order, type OrderCustomer, type OrderFulfillmentRequest, type OrderSessionStatus, type OrdersList, type PauseRetainerData, type PauseRetainerError, type PauseRetainerErrors, type PauseRetainerResponse, type PauseRetainerResponses, type PauseSiteCheckoutData, type PauseSiteCheckoutError, type PauseSiteCheckoutErrors, type PauseSiteCheckoutResponse, type PauseSiteCheckoutResponses, type PaymentsStatus, type PeopleList, type PersonDetail, type PersonRow, type PortalSessionResult, type PreviewInvoice, type PreviewInvoiceData, type PreviewInvoiceError, type PreviewInvoiceErrors, type PreviewInvoiceResponse, type PreviewInvoiceResponses, type PreviewSessionResult, type Product, type ProductDetail, type ProductFulfillment, type ProductFulfillmentInput, type ProductSubscriptionConfig, type ProductsList, type PublicOption, type PublicProduct, type PublicSubscription, type PublicSubscriptionPlan, type PublicVariant, type ReactivateSiteSubscriptionsTeardownData, type ReactivateSiteSubscriptionsTeardownError, type ReactivateSiteSubscriptionsTeardownErrors, type ReactivateSiteSubscriptionsTeardownResponse, type ReactivateSiteSubscriptionsTeardownResponses, type RecipientCooldownError, type ReconcileOptionInput, type ReconcileOptionValueInput, type ReconcileVariantInput, type RefundOrder, type RefundOrderData, type RefundOrderError, type RefundOrderErrors, type RefundOrderResponse, type RefundOrderResponses, type RefundResult, type ReissueResult, type RemindInvoiceData, type RemindInvoiceError, type RemindInvoiceErrors, type RemindInvoiceResponse, type RemindInvoiceResponses, type RemindInvoiceResult, type ResendInvoiceData, type ResendInvoiceError, type ResendInvoiceErrors, type ResendInvoiceResponse, type ResendInvoiceResponses, type ResendOrderReceiptData, type ResendOrderReceiptError, type ResendOrderReceiptErrors, type ResendOrderReceiptResponse, type ResendOrderReceiptResponses, type ResendReceiptResult, type ResetOrderDownloadsData, type ResetOrderDownloadsError, type ResetOrderDownloadsErrors, type ResetOrderDownloadsResponse, type ResetOrderDownloadsResponses, type ResetWebhookEventData, type ResetWebhookEventError, type ResetWebhookEventErrors, type ResetWebhookEventResponse, type ResetWebhookEventResponses, type ResolveManageLinkData, type ResolveManageLinkError, type ResolveManageLinkErrors, type ResolveManageLinkResponse, type ResolveManageLinkResponses, type ResumeRetainerData, type ResumeRetainerError, type ResumeRetainerErrors, type ResumeRetainerResponse, type ResumeRetainerResponses, type Retainer, type RetainerError, type RetainerSiteBody, type RetainersList, type RetryEventDeliveryData, type RetryEventDeliveryError, type RetryEventDeliveryErrors, type RetryEventDeliveryResponse, type RetryEventDeliveryResponses, type RetryEventDeliveryWithSiteTokenData, type RetryEventDeliveryWithSiteTokenError, type RetryEventDeliveryWithSiteTokenErrors, type RetryEventDeliveryWithSiteTokenResponse, type RetryEventDeliveryWithSiteTokenResponses, type RevokeCustomerAccessData, type RevokeCustomerAccessError, type RevokeCustomerAccessErrors, type RevokeCustomerAccessResponse, type RevokeCustomerAccessResponses, type RevokeCustomerAccessResult, type RotateEventDestinationSecretData, type RotateEventDestinationSecretError, type RotateEventDestinationSecretErrors, type RotateEventDestinationSecretResponse, type RotateEventDestinationSecretResponses, type RotateEventDestinationSecretWithSiteTokenData, type RotateEventDestinationSecretWithSiteTokenError, type RotateEventDestinationSecretWithSiteTokenErrors, type RotateEventDestinationSecretWithSiteTokenResponse, type RotateEventDestinationSecretWithSiteTokenResponses, type SalesSummary, type SalesSummaryProductRow, type SalesSummarySeriesEntry, type SetInventory, type SetInvoiceReminders, type SetInvoiceRemindersData, type SetInvoiceRemindersError, type SetInvoiceRemindersErrors, type SetInvoiceRemindersResponse, type SetInvoiceRemindersResponses, type SetOrderFulfillmentData, type SetOrderFulfillmentErrors, type SetOrderFulfillmentResponse, type SetOrderFulfillmentResponses, type SetProductSubscription, type SetProductSubscriptionData, type SetProductSubscriptionError, type SetProductSubscriptionErrors, type SetProductSubscriptionResponse, type SetProductSubscriptionResponses, type SetProductVariants, type SetProductVariantsConflict, type SetProductVariantsData, type SetProductVariantsError, type SetProductVariantsErrors, type SetProductVariantsResponse, type SetProductVariantsResponses, type SetProductVariantsResult, type SetVariantInventoryData, type SetVariantInventoryError, type SetVariantInventoryErrors, type SetVariantInventoryResponse, type SetVariantInventoryResponses, type SettledTotals, type ShippingOptionUnavailable, type ShippingRateInput, type Site, type SiteAccountRoute, type SiteDomains, type SitePayments, type SiteWithRestatement, type SiteWithToken, type SitesList, type SkipNextRetainerCycleData, type SkipNextRetainerCycleError, type SkipNextRetainerCycleErrors, type SkipNextRetainerCycleResponse, type SkipNextRetainerCycleResponses, type SnoozeInvoice, type SnoozeInvoiceData, type SnoozeInvoiceError, type SnoozeInvoiceErrors, type SnoozeInvoiceResponse, type SnoozeInvoiceResponses, type Submission, type SubmissionMetadata, type SubmissionsList, type SubscriberActionResult, type SubscriberSubscription, type SubscriptionPlan, type SubscriptionPlanInput, type SubscriptionSummary, type SubscriptionsList, type SubscriptionsReactivateBody, type SubscriptionsReactivateResult, type SubscriptionsTeardownBody, type SubscriptionsTeardownResult, type SummaryPeriod, type TeardownReason, type TeardownSiteSubscriptionsData, type TeardownSiteSubscriptionsError, type TeardownSiteSubscriptionsErrors, type TeardownSiteSubscriptionsResponse, type TeardownSiteSubscriptionsResponses, type TestOrderResult, type TestShippingAddress, type TestSubscriptionResult, type UpdateCustomer, type UpdateCustomerBilling, type UpdateCustomerBillingData, type UpdateCustomerBillingError, type UpdateCustomerBillingErrors, type UpdateCustomerBillingResponse, type UpdateCustomerBillingResponses, type UpdateCustomerData, type UpdateCustomerError, type UpdateCustomerErrors, type UpdateCustomerResponse, type UpdateCustomerResponses, type UpdateEventDestination, type UpdateEventDestinationData, type UpdateEventDestinationError, type UpdateEventDestinationErrors, type UpdateEventDestinationResponse, type UpdateEventDestinationResponses, type UpdateEventDestinationWithSiteTokenData, type UpdateEventDestinationWithSiteTokenError, type UpdateEventDestinationWithSiteTokenErrors, type UpdateEventDestinationWithSiteTokenResponse, type UpdateEventDestinationWithSiteTokenResponses, type UpdateForm, type UpdateFormData, type UpdateFormError, type UpdateFormErrors, type UpdateFormResponse, type UpdateFormResponses, type UpdateInvoiceRecipient, type UpdateInvoiceRecipientData, type UpdateInvoiceRecipientError, type UpdateInvoiceRecipientErrors, type UpdateInvoiceRecipientResponse, type UpdateInvoiceRecipientResponses, type UpdateInvoiceSettings, type UpdateInvoiceSettingsData, type UpdateInvoiceSettingsError, type UpdateInvoiceSettingsErrors, type UpdateInvoiceSettingsResponse, type UpdateInvoiceSettingsResponses, type UpdateOption, type UpdateOptionData, type UpdateOptionError, type UpdateOptionErrors, type UpdateOptionResponse, type UpdateOptionResponses, type UpdateProduct, type UpdateProductData, type UpdateProductError, type UpdateProductErrors, type UpdateProductResponse, type UpdateProductResponses, type UpdateRecipientResult, type UpdateRetainer, type UpdateRetainerData, type UpdateRetainerError, type UpdateRetainerErrors, type UpdateRetainerResponse, type UpdateRetainerResponses, type UpdateSite, type UpdateSiteAccountRoute, type UpdateSiteAccountRouteData, type UpdateSiteAccountRouteError, type UpdateSiteAccountRouteErrors, type UpdateSiteAccountRouteResponse, type UpdateSiteAccountRouteResponses, type UpdateSiteData, type UpdateSiteDomains, type UpdateSiteDomainsData, type UpdateSiteDomainsError, type UpdateSiteDomainsErrors, type UpdateSiteDomainsResponse, type UpdateSiteDomainsResponses, type UpdateSiteError, type UpdateSiteErrors, type UpdateSiteInvoicing, type UpdateSiteInvoicingData, type UpdateSiteInvoicingError, type UpdateSiteInvoicingErrors, type UpdateSiteInvoicingResponse, type UpdateSiteInvoicingResponses, type UpdateSitePayments, type UpdateSitePaymentsData, type UpdateSitePaymentsError, type UpdateSitePaymentsErrors, type UpdateSitePaymentsResponse, type UpdateSitePaymentsResponses, type UpdateSiteResponse, type UpdateSiteResponses, type UpdateSubscriptionAddressRequest, type UpdateVariant, type UpdateVariantData, type UpdateVariantError, type UpdateVariantErrors, type UpdateVariantResponse, type UpdateVariantResponses, type Variant, type VariantOptionValue, type VoidInvoice, type VoidInvoiceData, type VoidInvoiceError, type VoidInvoiceErrors, type VoidInvoiceResponse, type VoidInvoiceResponses, type VoidInvoiceResult, type WebhookEventResetResult, accountCancelSubscription, accountCreatePortalSession, accountLogin, accountLogout, accountManageCancel, accountManageGetSubscription, accountManagePortalSession, accountManageVerify, accountMe, accountReactivateSubscription, accountSubscribe, accountUpdateSubscriptionAddress, accountVerify, actOnManageLink, adjustVariantInventory, attachProductFile, cancelRetainer, cancelSubscription, createCartCheckout, createCheckout, createClient, createConfig, createCustomer, createEventDestination, createEventDestinationWithSiteToken, createForm, createFormWithSiteToken, createInvoice, createMultiItemTestOrder, createOption, createPreviewSession, createProduct, createProductWithSiteToken, createRetainer, createSite, createTestOrder, createTestSubscription, createVariant, deleteEventDestination, deleteEventDestinationWithSiteToken, deleteForm, deleteOption, deleteProduct, deleteSite, deleteSubmission, deleteVariant, downloadAttachment, downloadFile, generateVariants, getBusinessSummary, getCartSummary, getCustomer, getEventDestination, getEventDestinationSecret, getEventDestinationSecretWithSiteToken, getForm, getGeo, getInvoice, getInvoicePreview, getInvoiceSettings, getInvoiceSettingsWithSiteToken, getNextPayout, getOrder, getOrderSession, getPaymentsStatus, getPerson, getProduct, getPublicProduct, getRetainer, getSalesSummary, getSite, getSiteCheckoutPause, getSubmission, listCustomers, listEventDeliveries, listEventDeliveriesWithSiteToken, listEventDestinations, listEventDestinationsWithSiteToken, listForms, listFormsWithSiteToken, listInvoices, listOrdersWithSiteToken, listPeople, listProducts, listProductsWithSiteToken, listRetainers, listSites, listSubmissions, listSubscriptions, markInvoicePaid, markInvoiceUncollectible, pauseRetainer, pauseSiteCheckout, previewInvoice, reactivateSiteSubscriptionsTeardown, refundOrder, remindInvoice, resendInvoice, resendOrderReceipt, resetOrderDownloads, resetWebhookEvent, resolveManageLink, resumeRetainer, retryEventDelivery, retryEventDeliveryWithSiteToken, revokeCustomerAccess, rotateEventDestinationSecret, rotateEventDestinationSecretWithSiteToken, setInvoiceReminders, setOrderFulfillment, setProductSubscription, setProductVariants, setVariantInventory, skipNextRetainerCycle, snoozeInvoice, teardownSiteSubscriptions, updateCustomer, updateCustomerBilling, updateEventDestination, updateEventDestinationWithSiteToken, updateForm, updateInvoiceRecipient, updateInvoiceSettings, updateOption, updateProduct, updateRetainer, updateSite, updateSiteAccountRoute, updateSiteDomains, updateSiteInvoicing, updateSitePayments, updateVariant, voidInvoice };
|