@flintpay/node 0.3.0-beta.1 → 0.4.0-beta.1

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/REFERENCE.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Flint Public API API reference
2
2
 
3
- Package 0.3.0-beta.1; API 2026-09-07.
3
+ Package 0.4.0-beta.1; API 2026-09-07.
4
4
 
5
5
  [Models and field descriptions](MODELS.md) · [Runtime guide](RUNTIME.md)
6
6
 
@@ -102,19 +102,20 @@ Returns high-level merchant analytics for the requested time range.
102
102
 
103
103
  `GET /v1/analytics/overview`
104
104
 
105
- Call: `getOverview(params: { "range": InputValue<"today" | "last_7_days" | "last_30_days">; "timezone"?: InputValue<string>; "include_previous_period"?: InputValue<boolean>; "Flint-Version"?: InputValue<string> }, options?: RequestOptions<"merchant" | "merchantKey">)`
105
+ Call: `getOverview(params: { "range": InputValue<"today" | "last_7_days" | "last_30_days" | "last_90_days">; "timezone"?: InputValue<string>; "include_previous_period"?: InputValue<boolean>; "currency"?: InputValue<string>; "Flint-Version"?: InputValue<string> }, options?: RequestOptions<"merchant" | "merchantKey">)`
106
106
 
107
107
  Path arguments: none. Params contain flat body fields and query/header fields.
108
108
 
109
- Canonical input schema (for configuration examples and HTTP fixtures): `{ "range": "today" | "last_7_days" | "last_30_days"; "timezone"?: string; "include_previous_period"?: boolean; "Flint-Version"?: string; }`
109
+ Canonical input schema (for configuration examples and HTTP fixtures): `{ "range": "today" | "last_7_days" | "last_30_days" | "last_90_days"; "timezone"?: string; "include_previous_period"?: boolean; "currency"?: string; "Flint-Version"?: string; }`
110
110
 
111
111
  Returned payload: `AnalyticsOverview`
112
112
 
113
113
  | Field | Presence | Type | Description |
114
114
  | --- | --- | --- | --- |
115
- | `range` | Required | string | Values: "today", "last_7_days", "last_30_days". |
115
+ | `range` | Required | string | Values: "today", "last_7_days", "last_30_days", "last_90_days". |
116
116
  | `timezone` | Optional | string | |
117
117
  | `include_previous_period` | Optional | boolean | |
118
+ | `currency` | Optional | string | ISO 4217 currency code. minLength: 3. maxLength: 3. pattern: ^[A-Z]{3}$. Example: "USD". |
118
119
  | `Flint-Version` | Optional | string | Format: date. |
119
120
 
120
121
  Returns the payload at `data` directly. Use `getOverviewWithResponse` for `body`, `meta` and `raw` without unwrapping.
@@ -132,19 +133,20 @@ Returns merchant payment volume buckets for the requested time range.
132
133
 
133
134
  `GET /v1/analytics/payment-volume-timeseries`
134
135
 
135
- Call: `getPaymentVolumeTimeseries(params: { "range": InputValue<"today" | "last_7_days" | "last_30_days">; "timezone"?: InputValue<string>; "include_previous_period"?: InputValue<boolean>; "Flint-Version"?: InputValue<string> }, options?: RequestOptions<"merchant" | "merchantKey">)`
136
+ Call: `getPaymentVolumeTimeseries(params: { "range": InputValue<"today" | "last_7_days" | "last_30_days" | "last_90_days">; "timezone"?: InputValue<string>; "include_previous_period"?: InputValue<boolean>; "currency"?: InputValue<string>; "Flint-Version"?: InputValue<string> }, options?: RequestOptions<"merchant" | "merchantKey">)`
136
137
 
137
138
  Path arguments: none. Params contain flat body fields and query/header fields.
138
139
 
139
- Canonical input schema (for configuration examples and HTTP fixtures): `{ "range": "today" | "last_7_days" | "last_30_days"; "timezone"?: string; "include_previous_period"?: boolean; "Flint-Version"?: string; }`
140
+ Canonical input schema (for configuration examples and HTTP fixtures): `{ "range": "today" | "last_7_days" | "last_30_days" | "last_90_days"; "timezone"?: string; "include_previous_period"?: boolean; "currency"?: string; "Flint-Version"?: string; }`
140
141
 
141
142
  Returned payload: `PaymentVolumeTimeseries`
142
143
 
143
144
  | Field | Presence | Type | Description |
144
145
  | --- | --- | --- | --- |
145
- | `range` | Required | string | Values: "today", "last_7_days", "last_30_days". |
146
+ | `range` | Required | string | Values: "today", "last_7_days", "last_30_days", "last_90_days". |
146
147
  | `timezone` | Optional | string | |
147
148
  | `include_previous_period` | Optional | boolean | |
149
+ | `currency` | Optional | string | ISO 4217 currency code. minLength: 3. maxLength: 3. pattern: ^[A-Z]{3}$. Example: "USD". |
148
150
  | `Flint-Version` | Optional | string | Format: date. |
149
151
 
150
152
  Returns the payload at `data` directly. Use `getPaymentVolumeTimeseriesWithResponse` for `body`, `meta` and `raw` without unwrapping.
@@ -162,17 +164,17 @@ Returns windowed subscription metrics plus current subscription snapshot metrics
162
164
 
163
165
  `GET /v1/analytics/subscriptions`
164
166
 
165
- Call: `getSubscription(params: { "range": InputValue<"today" | "last_7_days" | "last_30_days">; "timezone"?: InputValue<string>; "Flint-Version"?: InputValue<string> }, options?: RequestOptions<"merchant" | "merchantKey">)`
167
+ Call: `getSubscription(params: { "range": InputValue<"today" | "last_7_days" | "last_30_days" | "last_90_days">; "timezone"?: InputValue<string>; "Flint-Version"?: InputValue<string> }, options?: RequestOptions<"merchant" | "merchantKey">)`
166
168
 
167
169
  Path arguments: none. Params contain flat body fields and query/header fields.
168
170
 
169
- Canonical input schema (for configuration examples and HTTP fixtures): `{ "range": "today" | "last_7_days" | "last_30_days"; "timezone"?: string; "Flint-Version"?: string; }`
171
+ Canonical input schema (for configuration examples and HTTP fixtures): `{ "range": "today" | "last_7_days" | "last_30_days" | "last_90_days"; "timezone"?: string; "Flint-Version"?: string; }`
170
172
 
171
173
  Returned payload: `SubscriptionAnalytics`
172
174
 
173
175
  | Field | Presence | Type | Description |
174
176
  | --- | --- | --- | --- |
175
- | `range` | Required | string | Values: "today", "last_7_days", "last_30_days". |
177
+ | `range` | Required | string | Values: "today", "last_7_days", "last_30_days", "last_90_days". |
176
178
  | `timezone` | Optional | string | |
177
179
  | `Flint-Version` | Optional | string | Format: date. |
178
180
 
@@ -957,7 +959,7 @@ for await (const page of client.categories.listPages({}, { maxPages: 10, maxItem
957
959
 
958
960
  ### categories.remove
959
961
 
960
- Delete category.
962
+ Permanently deletes an unreferenced category and returns it with status deleted. Deleted categories cannot be retrieved or listed. Remove all product, bundle, promotion, and return configuration references before deleting.
961
963
 
962
964
  `DELETE /v1/categories/{category_id}`
963
965
 
@@ -1513,6 +1515,38 @@ Idempotency header: Idempotency-Key; retention: Use the endpoint-specific replay
1513
1515
  [Example](examples/creditNotes-createAllocation.mjs)
1514
1516
 
1515
1517
 
1518
+ ### creditNotes.createRefund
1519
+
1520
+ Creates a refund against an issued credit note on a paid invoice. Omit amount_money to refund all available credit. Refunds use the source invoice's original payments and do not reopen its balance. Idempotency-Key is required and retained for the lifetime of the refund command, scoped to merchant, environment, credit note, and key. Reusing it with another request conflicts. Recover a lost response by listing this note's refunds with idempotency_key. A failed remainder can be requested with a new key after its outcome is definitive.
1521
+
1522
+ `POST /v1/credit-notes/{credit_note_id}/refunds`
1523
+
1524
+ Call: `createRefund(credit_note_id: InputValue<string>, params: (InputValue<{ "amount_money"?: MoneyValueInput; "expected_version"?: string; "reason": "duplicate" | "fraudulent" | "requested_by_customer" | "defective_product" | "wrong_item_shipped" | "never_received" | "not_as_described" | "arrived_too_late" | "customer_changed_mind" | "better_price_found" | "accidental_order" | "other"; "reason_message"?: string; [key: string]: unknown; }>) & { "Idempotency-Key"?: InputValue<string>; "Flint-Version"?: InputValue<string> }, options?: RequestOptions<"merchant" | "merchantKey">)`
1525
+
1526
+ Path arguments: `path0` = `credit_note_id`. Params contain flat body fields and query/header fields.
1527
+
1528
+ Canonical input schema (for configuration examples and HTTP fixtures): `{ "credit_note_id": string; "Idempotency-Key"?: string; "Flint-Version"?: string; "body": { "amount_money"?: MoneyValueInput; "expected_version"?: string; "reason": "duplicate" | "fraudulent" | "requested_by_customer" | "defective_product" | "wrong_item_shipped" | "never_received" | "not_as_described" | "arrived_too_late" | "customer_changed_mind" | "better_price_found" | "accidental_order" | "other"; "reason_message"?: string; [key: string]: unknown; }; }`
1529
+
1530
+ Returned payload: `Refund`
1531
+
1532
+ | Field | Presence | Type | Description |
1533
+ | --- | --- | --- | --- |
1534
+ | `credit_note_id` | Required | string | |
1535
+ | `Idempotency-Key` | Optional | string | |
1536
+ | `Flint-Version` | Optional | string | Format: date. |
1537
+ | `body` | Required | object | |
1538
+
1539
+ Returns the payload at `data` directly. Use `createRefundWithResponse` for `body`, `meta` and `raw` without unwrapping.
1540
+
1541
+ Authentication modes: `merchant`, `merchantKey`. See [credential setup](RUNTIME.md#authentication).
1542
+
1543
+ Request options are the second argument. Default attempts: 1; maximum: 1. For mutation retries, supply a stable idempotency key and reuse it for the same business action.
1544
+
1545
+ Idempotency header: Idempotency-Key; retention: Use the endpoint-specific replay lifetime; the general Flint replay window is 24 hours unless the endpoint documents an exception.; scope: Endpoint-defined command identity. Required caller-chosen command identity. Reuse it when retrying the same refund..
1546
+
1547
+ [Example](examples/creditNotes-createRefund.mjs)
1548
+
1549
+
1516
1550
  ### creditNotes.get
1517
1551
 
1518
1552
  Returns one credit note with its lines, total, and the credit still available to allocate.
@@ -1598,17 +1632,17 @@ Request options are the second argument. Default attempts: 1; maximum: 1.
1598
1632
 
1599
1633
  ### creditNotes.issue
1600
1634
 
1601
- Issues a draft credit note. Assigns credit_note_number, freezes the lines, renders the PDF, and sets unallocated_money to the total. The over-credit check runs here rather than on line edits: across every issued credit note, an invoice line cannot be credited past its frozen value. Issuing does not change the invoice; allocating does.
1635
+ Issues a draft credit note and freezes its PDF. Optionally provide refund to initiate a linked refund on a paid invoice. With refund, Idempotency-Key is required and retained for the lifetime of the refund command, scoped to merchant, environment, credit note, and key. Reuse the key with the identical request to recover the original result. Use the credit note refunds list filtered by idempotency_key after a lost response. A pending refund is accepted, not completed. Without refund, issuance does not move money.
1602
1636
 
1603
1637
  `POST /v1/credit-notes/{credit_note_id}/issue`
1604
1638
 
1605
- Call: `issue(credit_note_id: InputValue<string>, params?: (InputValue<{ "expected_version"?: string; [key: string]: unknown; }> | { "expected_version"?: never }) & { "Idempotency-Key"?: InputValue<string>; "Flint-Version"?: InputValue<string> }, options?: RequestOptions<"merchant" | "merchantKey">)`
1639
+ Call: `issue(credit_note_id: InputValue<string>, params?: (InputValue<{ "expected_version"?: string; "refund"?: CreditNoteRefundRequestInput; [key: string]: unknown; }> | { "expected_version"?: never; "refund"?: never }) & { "Idempotency-Key"?: InputValue<string>; "Flint-Version"?: InputValue<string> }, options?: RequestOptions<"merchant" | "merchantKey">)`
1606
1640
 
1607
1641
  Path arguments: `path0` = `credit_note_id`. Params contain flat body fields and query/header fields.
1608
1642
 
1609
- Canonical input schema (for configuration examples and HTTP fixtures): `{ "credit_note_id": string; "Idempotency-Key"?: string; "Flint-Version"?: string; "body"?: { "expected_version"?: string; [key: string]: unknown; }; }`
1643
+ Canonical input schema (for configuration examples and HTTP fixtures): `{ "credit_note_id": string; "Idempotency-Key"?: string; "Flint-Version"?: string; "body"?: { "expected_version"?: string; "refund"?: CreditNoteRefundRequestInput; [key: string]: unknown; }; }`
1610
1644
 
1611
- Returned payload: `CreditNote`
1645
+ Returned payload: `IssuedCreditNote`
1612
1646
 
1613
1647
  | Field | Presence | Type | Description |
1614
1648
  | --- | --- | --- | --- |
@@ -1752,6 +1786,67 @@ for await (const page of client.creditNotes.listAllocationsPages("example", {},
1752
1786
  ```
1753
1787
 
1754
1788
 
1789
+ ### creditNotes.listRefunds
1790
+
1791
+ Lists linked refunds, including failed attempts, newest first. Filter by idempotency_key to recover a refund after a lost response.
1792
+
1793
+ `GET /v1/credit-notes/{credit_note_id}/refunds`
1794
+
1795
+ Call: `listRefunds(credit_note_id: InputValue<string>, params?: { "page_size"?: InputValue<number>; "page_token"?: InputValue<string>; "idempotency_key"?: InputValue<string>; "Flint-Version"?: InputValue<string> }, options?: RequestOptions<"merchant" | "merchantKey">)`
1796
+
1797
+ Path arguments: `path0` = `credit_note_id`. Params contain flat body fields and query/header fields.
1798
+
1799
+ Canonical input schema (for configuration examples and HTTP fixtures): `{ "credit_note_id": string; "page_size"?: number; "page_token"?: string; "idempotency_key"?: string; "Flint-Version"?: string; }`
1800
+
1801
+ Returned payload: `Array<Refund>`
1802
+
1803
+ | Field | Presence | Type | Description |
1804
+ | --- | --- | --- | --- |
1805
+ | `credit_note_id` | Required | string | |
1806
+ | `page_size` | Optional | integer | minimum: 1. maximum: 100. |
1807
+ | `page_token` | Optional | string | |
1808
+ | `idempotency_key` | Optional | string | |
1809
+ | `Flint-Version` | Optional | string | Format: date. |
1810
+
1811
+ Returns the payload at `data` directly. Use `listRefundsWithResponse` for `body`, `meta` and `raw` without unwrapping.
1812
+
1813
+ Authentication modes: `merchant`, `merchantKey`. See [credential setup](RUNTIME.md#authentication).
1814
+
1815
+ Request options are the second argument. Default attempts: 1; maximum: 1.
1816
+
1817
+ [Example](examples/creditNotes-listRefunds.mjs)
1818
+
1819
+ #### creditNotes.listRefundsItems
1820
+
1821
+ Iterate individual values across pages. Iteration is lazy; all pages share the deadline.
1822
+
1823
+ ```typescript
1824
+ import { Client } from '@flintpay/node';
1825
+ const client = new Client({
1826
+ baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
1827
+ apiKey: process.env.API_KEY ?? '',
1828
+ });
1829
+ for await (const item of client.creditNotes.listRefundsItems("example", {}, { maxPages: 10, maxItems: 1000, deadlineMs: 60000 })) {
1830
+ console.log(item);
1831
+ }
1832
+ ```
1833
+
1834
+ #### creditNotes.listRefundsPages
1835
+
1836
+ Iterate page Results, including HTTP metadata. Iteration is lazy; all pages share the deadline.
1837
+
1838
+ ```typescript
1839
+ import { Client } from '@flintpay/node';
1840
+ const client = new Client({
1841
+ baseUrl: process.env.API_BASE_URL ?? 'https://sandbox.example.invalid',
1842
+ apiKey: process.env.API_KEY ?? '',
1843
+ });
1844
+ for await (const page of client.creditNotes.listRefundsPages("example", {}, { maxPages: 10, maxItems: 1000, deadlineMs: 60000 })) {
1845
+ console.log(page.meta.requestId);
1846
+ }
1847
+ ```
1848
+
1849
+
1755
1850
  ### creditNotes.reverseAllocation
1756
1851
 
1757
1852
  Reverses an allocation and reopens that much of the invoice balance. The original allocation keeps its row and gains reversed_at, so the history stays append-only. Reversing the allocation that closed an invoice moves it from credited back to open or partially_paid.
@@ -1954,11 +2049,11 @@ Creates a customer for the authenticated merchant.
1954
2049
 
1955
2050
  `POST /v1/customers`
1956
2051
 
1957
- Call: `create(params: (InputValue<{ "billing_address"?: PostalAddressInput; "default_invoice_payment_term_id"?: string; "email": string; "external_reference_id"?: string; "group_id"?: string; "internal_note"?: string; "is_verified"?: boolean; "metadata"?: Record<string, string>; "name"?: string; "phone"?: string; "shipping_address"?: PostalAddressInput; "tax_exempt"?: boolean; [key: string]: unknown; }>) & { "Idempotency-Key"?: InputValue<string>; "X-Request-Id"?: InputValue<string>; "Flint-Version"?: InputValue<string> }, options?: RequestOptions<"merchant" | "merchantKey">)`
2052
+ Call: `create(params: (InputValue<{ "billing_address"?: PostalAddressInput; "default_invoice_payment_term_id"?: string; "email": string; "external_reference_id"?: string; "group_id"?: string; "internal_note"?: string; "is_verified"?: boolean; "metadata"?: Record<string, string>; "name"?: string; "phone"?: string; "shipping_address"?: PostalAddressInput; "tax_exempt"?: boolean; "tax_identity"?: TaxIdentityPatchInput; [key: string]: unknown; }>) & { "Idempotency-Key"?: InputValue<string>; "X-Request-Id"?: InputValue<string>; "Flint-Version"?: InputValue<string> }, options?: RequestOptions<"merchant" | "merchantKey">)`
1958
2053
 
1959
2054
  Path arguments: none. Params contain flat body fields and query/header fields.
1960
2055
 
1961
- Canonical input schema (for configuration examples and HTTP fixtures): `{ "Idempotency-Key"?: string; "X-Request-Id"?: string; "Flint-Version"?: string; "body": { "billing_address"?: PostalAddressInput; "default_invoice_payment_term_id"?: string; "email": string; "external_reference_id"?: string; "group_id"?: string; "internal_note"?: string; "is_verified"?: boolean; "metadata"?: Record<string, string>; "name"?: string; "phone"?: string; "shipping_address"?: PostalAddressInput; "tax_exempt"?: boolean; [key: string]: unknown; }; }`
2056
+ Canonical input schema (for configuration examples and HTTP fixtures): `{ "Idempotency-Key"?: string; "X-Request-Id"?: string; "Flint-Version"?: string; "body": { "billing_address"?: PostalAddressInput; "default_invoice_payment_term_id"?: string; "email": string; "external_reference_id"?: string; "group_id"?: string; "internal_note"?: string; "is_verified"?: boolean; "metadata"?: Record<string, string>; "name"?: string; "phone"?: string; "shipping_address"?: PostalAddressInput; "tax_exempt"?: boolean; "tax_identity"?: TaxIdentityPatchInput; [key: string]: unknown; }; }`
1962
2057
 
1963
2058
  Returned payload: `Customer`
1964
2059
 
@@ -2369,11 +2464,11 @@ Applies a sparse update to a customer. Writing billing_address or shipping_addre
2369
2464
 
2370
2465
  `PATCH /v1/customers/{customer_id}`
2371
2466
 
2372
- Call: `update(customer_id: InputValue<string>, params: (InputValue<{ "billing_address"?: PostalAddressInput; "default_invoice_payment_term_id"?: string; "external_reference_id"?: string; "group_id"?: string; "internal_note"?: string; "is_verified"?: boolean; "metadata"?: Record<string, string | null> | null; "name"?: string; "phone"?: string; "shipping_address"?: PostalAddressInput; "tax_exempt"?: boolean; [key: string]: unknown; }>) & { "Idempotency-Key"?: InputValue<string>; "X-Request-Id"?: InputValue<string>; "Flint-Version"?: InputValue<string> }, options?: RequestOptions<"merchant" | "merchantKey">)`
2467
+ Call: `update(customer_id: InputValue<string>, params: (InputValue<({ "billing_address"?: PostalAddressInput; "default_invoice_payment_term_id"?: string; "expected_version"?: string; "external_reference_id"?: string; "group_id"?: string; "internal_note"?: string; "is_verified"?: boolean; "metadata"?: Record<string, string | null> | null; "name"?: string; "phone"?: string; "shipping_address"?: PostalAddressInput; "tax_exempt"?: boolean; "tax_identity"?: (({ "legal_name"?: string | null; "registered_address"?: (({ "city": string; "country": string; "line1": string; "line2"?: string; "postal_code": string; "state": string; [key: string]: unknown; }) | (null)); "tax_ids"?: Array<DocumentTaxIDInput>; [key: string]: unknown; }) | (null)); [key: string]: unknown; })>) & { "Idempotency-Key"?: InputValue<string>; "X-Request-Id"?: InputValue<string>; "Flint-Version"?: InputValue<string> }, options?: RequestOptions<"merchant" | "merchantKey">)`
2373
2468
 
2374
2469
  Path arguments: `path0` = `customer_id`. Params contain flat body fields and query/header fields.
2375
2470
 
2376
- Canonical input schema (for configuration examples and HTTP fixtures): `{ "customer_id": string; "Idempotency-Key"?: string; "X-Request-Id"?: string; "Flint-Version"?: string; "body": { "billing_address"?: PostalAddressInput; "default_invoice_payment_term_id"?: string; "external_reference_id"?: string; "group_id"?: string; "internal_note"?: string; "is_verified"?: boolean; "metadata"?: Record<string, string | null> | null; "name"?: string; "phone"?: string; "shipping_address"?: PostalAddressInput; "tax_exempt"?: boolean; [key: string]: unknown; }; }`
2471
+ Canonical input schema (for configuration examples and HTTP fixtures): `{ "customer_id": string; "Idempotency-Key"?: string; "X-Request-Id"?: string; "Flint-Version"?: string; "body": ({ "billing_address"?: PostalAddressInput; "default_invoice_payment_term_id"?: string; "expected_version"?: string; "external_reference_id"?: string; "group_id"?: string; "internal_note"?: string; "is_verified"?: boolean; "metadata"?: Record<string, string | null> | null; "name"?: string; "phone"?: string; "shipping_address"?: PostalAddressInput; "tax_exempt"?: boolean; "tax_identity"?: (({ "legal_name"?: string | null; "registered_address"?: (({ "city": string; "country": string; "line1": string; "line2"?: string; "postal_code": string; "state": string; [key: string]: unknown; }) | (null)); "tax_ids"?: Array<DocumentTaxIDInput>; [key: string]: unknown; }) | (null)); [key: string]: unknown; }); }`
2377
2472
 
2378
2473
  Returned payload: `Customer`
2379
2474
 
@@ -3922,7 +4017,7 @@ Idempotency header: Idempotency-Key; retention: Use the endpoint-specific replay
3922
4017
 
3923
4018
  ### developer.getAuthContext
3924
4019
 
3925
- Returns non-secret metadata for the authenticated API key, including its merchant, environment, sandbox binding, and granted scopes. A valid API key is required, but no additional API scope is required.
4020
+ Returns non-secret metadata for an API key or CLI OAuth access token, including its merchant, environment, sandbox binding, and granted scopes. CLI OAuth sessions include auth_type=oauth and a stable oauth_grant_id instead of api_key_id. Multi-context tokens also include oauth_session_id, context_id, and the context name. No additional API scope is required.
3926
4021
 
3927
4022
  `GET /v1/developer/auth-context`
3928
4023
 
@@ -6137,15 +6232,15 @@ Idempotency header: Idempotency-Key; retention: Use the endpoint-specific replay
6137
6232
 
6138
6233
  ### inventoryLevels.list
6139
6234
 
6140
- List inventory levels. Levels are strongly consistent individually, but pages may reflect different committed instants.
6235
+ List inventory levels. Send expand=inventory_item to render each level's inventory item inline, so a stock table needs no read per row. Filter by inventory_item_status to see only the levels behind items that can be sold. Levels are strongly consistent individually, but pages may reflect different committed instants.
6141
6236
 
6142
6237
  `GET /v1/inventory-levels`
6143
6238
 
6144
- Call: `list(params?: { "page_size"?: InputValue<number>; "page_token"?: InputValue<string>; "inventory_item_id"?: InputValue<string>; "location_id"?: InputValue<string>; "has_available_quantity"?: InputValue<boolean>; "has_unavailable_condition"?: InputValue<boolean>; "has_shortage"?: InputValue<boolean>; "updated_after"?: InputValue<string>; "updated_before"?: InputValue<string>; "Flint-Version"?: InputValue<string> }, options?: RequestOptions<"merchant" | "merchantKey">)`
6239
+ Call: `list(params?: { "page_size"?: InputValue<number>; "page_token"?: InputValue<string>; "inventory_item_id"?: InputValue<string>; "location_id"?: InputValue<string>; "inventory_item_status"?: InputValue<"active" | "inactive" | "archived">; "has_available_quantity"?: InputValue<boolean>; "has_unavailable_condition"?: InputValue<boolean>; "has_shortage"?: InputValue<boolean>; "query"?: InputValue<string>; "min_available_quantity"?: InputValue<string>; "max_available_quantity"?: InputValue<string>; "updated_after"?: InputValue<string>; "updated_before"?: InputValue<string>; "expand"?: InputValue<Array<"inventory_item">>; "Flint-Version"?: InputValue<string> }, options?: RequestOptions<"merchant" | "merchantKey">)`
6145
6240
 
6146
6241
  Path arguments: none. Params contain flat body fields and query/header fields.
6147
6242
 
6148
- Canonical input schema (for configuration examples and HTTP fixtures): `{ "page_size"?: number; "page_token"?: string; "inventory_item_id"?: string; "location_id"?: string; "has_available_quantity"?: boolean; "has_unavailable_condition"?: boolean; "has_shortage"?: boolean; "updated_after"?: string; "updated_before"?: string; "Flint-Version"?: string; }`
6243
+ Canonical input schema (for configuration examples and HTTP fixtures): `{ "page_size"?: number; "page_token"?: string; "inventory_item_id"?: string; "location_id"?: string; "inventory_item_status"?: "active" | "inactive" | "archived"; "has_available_quantity"?: boolean; "has_unavailable_condition"?: boolean; "has_shortage"?: boolean; "query"?: string; "min_available_quantity"?: string; "max_available_quantity"?: string; "updated_after"?: string; "updated_before"?: string; "expand"?: Array<"inventory_item">; "Flint-Version"?: string; }`
6149
6244
 
6150
6245
  Returned payload: `Array<InventoryLevel>`
6151
6246
 
@@ -6155,11 +6250,16 @@ Returned payload: `Array<InventoryLevel>`
6155
6250
  | `page_token` | Optional | string | |
6156
6251
  | `inventory_item_id` | Optional | string | |
6157
6252
  | `location_id` | Optional | string | |
6253
+ | `inventory_item_status` | Optional | string | Values: "active", "inactive", "archived". |
6158
6254
  | `has_available_quantity` | Optional | boolean | |
6159
6255
  | `has_unavailable_condition` | Optional | boolean | |
6160
6256
  | `has_shortage` | Optional | boolean | |
6257
+ | `query` | Optional | string | maxLength: 255. |
6258
+ | `min_available_quantity` | Optional | exact numeric string | Use an exact numeric string, not a floating-point number. Format: int64. minimum: 0. |
6259
+ | `max_available_quantity` | Optional | exact numeric string | Use an exact numeric string, not a floating-point number. Format: int64. minimum: 0. |
6161
6260
  | `updated_after` | Optional | string | Format: date-time. Example: "2026-03-17T14:30:00Z". |
6162
6261
  | `updated_before` | Optional | string | Format: date-time. Example: "2026-03-17T14:30:00Z". |
6262
+ | `expand` | Optional | Array of string | |
6163
6263
  | `Flint-Version` | Optional | string | Format: date. |
6164
6264
 
6165
6265
  Returns the payload at `data` directly. Use `listWithResponse` for `body`, `meta` and `raw` without unwrapping.
@@ -6237,15 +6337,15 @@ Idempotency header: Idempotency-Key; retention: Retained for at least as long as
6237
6337
 
6238
6338
  ### inventoryMovements.list
6239
6339
 
6240
- List inventory movements. Filter by idempotency_key to recover the movements a command produced.
6340
+ List inventory movements, oldest recorded first. Send expand=inventory_item to render each movement's inventory item inline, so a history table needs no read per row. Filter by idempotency_key to recover the movements a command produced. Send order=desc to read the newest movements first.
6241
6341
 
6242
6342
  `GET /v1/inventory-movements`
6243
6343
 
6244
- Call: `list(params?: { "page_size"?: InputValue<number>; "page_token"?: InputValue<string>; "inventory_item_id"?: InputValue<string>; "location_id"?: InputValue<string>; "type"?: InputValue<string>; "reason"?: InputValue<string>; "idempotency_key"?: InputValue<string>; "return_id"?: InputValue<string>; "return_disposition_id"?: InputValue<string>; "source_system_type"?: InputValue<"manual" | "pos" | "wms" | "erp" | "flint" | "other">; "external_source_id"?: InputValue<string>; "external_actor_id"?: InputValue<string>; "occurred_after"?: InputValue<string>; "occurred_before"?: InputValue<string>; "created_after"?: InputValue<string>; "created_before"?: InputValue<string>; "source_reference_type"?: InputValue<string>; "source_reference_id"?: InputValue<string>; "Flint-Version"?: InputValue<string> }, options?: RequestOptions<"merchant" | "merchantKey">)`
6344
+ Call: `list(params?: { "page_size"?: InputValue<number>; "page_token"?: InputValue<string>; "inventory_item_id"?: InputValue<string>; "location_id"?: InputValue<string>; "type"?: InputValue<string>; "reason"?: InputValue<string>; "idempotency_key"?: InputValue<string>; "return_id"?: InputValue<string>; "return_disposition_id"?: InputValue<string>; "order"?: InputValue<"asc" | "desc">; "expand"?: InputValue<Array<"inventory_item">>; "source_system_type"?: InputValue<"manual" | "pos" | "wms" | "erp" | "flint" | "other">; "external_source_id"?: InputValue<string>; "external_actor_id"?: InputValue<string>; "occurred_after"?: InputValue<string>; "occurred_before"?: InputValue<string>; "created_after"?: InputValue<string>; "created_before"?: InputValue<string>; "source_reference_type"?: InputValue<string>; "source_reference_id"?: InputValue<string>; "Flint-Version"?: InputValue<string> }, options?: RequestOptions<"merchant" | "merchantKey">)`
6245
6345
 
6246
6346
  Path arguments: none. Params contain flat body fields and query/header fields.
6247
6347
 
6248
- Canonical input schema (for configuration examples and HTTP fixtures): `{ "page_size"?: number; "page_token"?: string; "inventory_item_id"?: string; "location_id"?: string; "type"?: string; "reason"?: string; "idempotency_key"?: string; "return_id"?: string; "return_disposition_id"?: string; "source_system_type"?: "manual" | "pos" | "wms" | "erp" | "flint" | "other"; "external_source_id"?: string; "external_actor_id"?: string; "occurred_after"?: string; "occurred_before"?: string; "created_after"?: string; "created_before"?: string; "source_reference_type"?: string; "source_reference_id"?: string; "Flint-Version"?: string; }`
6348
+ Canonical input schema (for configuration examples and HTTP fixtures): `{ "page_size"?: number; "page_token"?: string; "inventory_item_id"?: string; "location_id"?: string; "type"?: string; "reason"?: string; "idempotency_key"?: string; "return_id"?: string; "return_disposition_id"?: string; "order"?: "asc" | "desc"; "expand"?: Array<"inventory_item">; "source_system_type"?: "manual" | "pos" | "wms" | "erp" | "flint" | "other"; "external_source_id"?: string; "external_actor_id"?: string; "occurred_after"?: string; "occurred_before"?: string; "created_after"?: string; "created_before"?: string; "source_reference_type"?: string; "source_reference_id"?: string; "Flint-Version"?: string; }`
6249
6349
 
6250
6350
  Returned payload: `Array<InventoryMovement>`
6251
6351
 
@@ -6260,6 +6360,8 @@ Returned payload: `Array<InventoryMovement>`
6260
6360
  | `idempotency_key` | Optional | string | |
6261
6361
  | `return_id` | Optional | string | |
6262
6362
  | `return_disposition_id` | Optional | string | |
6363
+ | `order` | Optional | string | Values: "asc", "desc". |
6364
+ | `expand` | Optional | Array of string | |
6263
6365
  | `source_system_type` | Optional | string | Values: "manual", "pos", "wms", "erp", "flint", "other". |
6264
6366
  | `external_source_id` | Optional | string | |
6265
6367
  | `external_actor_id` | Optional | string | |
@@ -6942,11 +7044,11 @@ Update invoice payment term for the authenticated merchant.
6942
7044
 
6943
7045
  `PATCH /v1/invoice-payment-terms/{invoice_payment_term_id}`
6944
7046
 
6945
- Call: `update(invoice_payment_term_id: InputValue<string>, params: (InputValue<{ "calculation"?: InvoicePaymentTermCalculationInput; "expected_version"?: number; "external_reference_id"?: string; "late_fee_policy"?: ((({ "amount_money"?: MoneyValueInput; "grace_period_days": number; "percent"?: string; "type": "fixed" | "percentage"; }) & ((({ "type": "fixed"; "grace_period_days": unknown; "amount_money": unknown; [key: string]: unknown; }) & ({ "percent"?: never })) | (({ "type": "percentage"; "grace_period_days": unknown; "percent": unknown; [key: string]: unknown; }) & ({ "amount_money"?: never })))) | (null)); "name"?: string; }>) & { "Idempotency-Key"?: InputValue<string>; "Flint-Version"?: InputValue<string> }, options?: RequestOptions<"merchant" | "merchantKey">)`
7047
+ Call: `update(invoice_payment_term_id: InputValue<string>, params: (InputValue<{ "calculation"?: InvoicePaymentTermCalculationInput; "expected_version"?: number; "external_reference_id"?: string; "late_fee_policy"?: ((({ "amount_money"?: MoneyValueInput; "application_mode"?: "manual" | "automatic"; "grace_period_days": number; "percent"?: string; "type": "fixed" | "percentage"; }) & ((({ "type": "fixed"; "grace_period_days": unknown; "amount_money": unknown; [key: string]: unknown; }) & ({ "percent"?: never })) | (({ "type": "percentage"; "grace_period_days": unknown; "percent": unknown; [key: string]: unknown; }) & ({ "amount_money"?: never })))) | (null)); "name"?: string; }>) & { "Idempotency-Key"?: InputValue<string>; "Flint-Version"?: InputValue<string> }, options?: RequestOptions<"merchant" | "merchantKey">)`
6946
7048
 
6947
7049
  Path arguments: `path0` = `invoice_payment_term_id`. Params contain flat body fields and query/header fields.
6948
7050
 
6949
- Canonical input schema (for configuration examples and HTTP fixtures): `{ "invoice_payment_term_id": string; "Idempotency-Key"?: string; "Flint-Version"?: string; "body": { "calculation"?: InvoicePaymentTermCalculationInput; "expected_version"?: number; "external_reference_id"?: string; "late_fee_policy"?: ((({ "amount_money"?: MoneyValueInput; "grace_period_days": number; "percent"?: string; "type": "fixed" | "percentage"; }) & ((({ "type": "fixed"; "grace_period_days": unknown; "amount_money": unknown; [key: string]: unknown; }) & ({ "percent"?: never })) | (({ "type": "percentage"; "grace_period_days": unknown; "percent": unknown; [key: string]: unknown; }) & ({ "amount_money"?: never })))) | (null)); "name"?: string; }; }`
7051
+ Canonical input schema (for configuration examples and HTTP fixtures): `{ "invoice_payment_term_id": string; "Idempotency-Key"?: string; "Flint-Version"?: string; "body": { "calculation"?: InvoicePaymentTermCalculationInput; "expected_version"?: number; "external_reference_id"?: string; "late_fee_policy"?: ((({ "amount_money"?: MoneyValueInput; "application_mode"?: "manual" | "automatic"; "grace_period_days": number; "percent"?: string; "type": "fixed" | "percentage"; }) & ((({ "type": "fixed"; "grace_period_days": unknown; "amount_money": unknown; [key: string]: unknown; }) & ({ "percent"?: never })) | (({ "type": "percentage"; "grace_period_days": unknown; "percent": unknown; [key: string]: unknown; }) & ({ "amount_money"?: never })))) | (null)); "name"?: string; }; }`
6950
7052
 
6951
7053
  Returned payload: `InvoicePaymentTerm`
6952
7054
 
@@ -6970,6 +7072,38 @@ Idempotency header: Idempotency-Key; retention: Use the endpoint-specific replay
6970
7072
 
6971
7073
  ## Resource: invoices
6972
7074
 
7075
+ ### invoices.assessLateFee
7076
+
7077
+ Assesses the frozen late fee policy once per invoice or overdue schedule entry. The issued document remains unchanged.
7078
+
7079
+ `POST /v1/invoices/{invoice_id}/late-fees`
7080
+
7081
+ Call: `assessLateFee(invoice_id: InputValue<string>, params: (InputValue<{ "invoice_schedule_entry_id"?: string; [key: string]: unknown; }>) & { "Idempotency-Key"?: InputValue<string>; "Flint-Version"?: InputValue<string> }, options?: RequestOptions<"merchant" | "merchantKey">)`
7082
+
7083
+ Path arguments: `path0` = `invoice_id`. Params contain flat body fields and query/header fields.
7084
+
7085
+ Canonical input schema (for configuration examples and HTTP fixtures): `{ "invoice_id": string; "Idempotency-Key"?: string; "Flint-Version"?: string; "body": { "invoice_schedule_entry_id"?: string; [key: string]: unknown; }; }`
7086
+
7087
+ Returned payload: `Invoice`
7088
+
7089
+ | Field | Presence | Type | Description |
7090
+ | --- | --- | --- | --- |
7091
+ | `invoice_id` | Required | string | |
7092
+ | `Idempotency-Key` | Optional | string | |
7093
+ | `Flint-Version` | Optional | string | Format: date. |
7094
+ | `body` | Required | object | |
7095
+
7096
+ Returns the payload at `data` directly. Use `assessLateFeeWithResponse` for `body`, `meta` and `raw` without unwrapping.
7097
+
7098
+ Authentication modes: `merchant`, `merchantKey`. See [credential setup](RUNTIME.md#authentication).
7099
+
7100
+ Request options are the second argument. Default attempts: 1; maximum: 1. For mutation retries, supply a stable idempotency key and reuse it for the same business action.
7101
+
7102
+ Idempotency header: Idempotency-Key; retention: Use the endpoint-specific replay lifetime; the general Flint replay window is 24 hours unless the endpoint documents an exception.; scope: Endpoint-defined command identity. Optional idempotency key for safe retries..
7103
+
7104
+ [Example](examples/invoices-assessLateFee.mjs)
7105
+
7106
+
6973
7107
  ### invoices.cancelPaymentAttempt
6974
7108
 
6975
7109
  Cancels an active invoice payment attempt and its payment intent. Safe to retry with the same Idempotency-Key.
@@ -7223,11 +7357,11 @@ Returns a paginated list of invoices for the authenticated merchant.
7223
7357
 
7224
7358
  `GET /v1/invoices`
7225
7359
 
7226
- Call: `list(params?: { "page_size"?: InputValue<number>; "page_token"?: InputValue<string>; "status"?: InputValue<"draft" | "open" | "partially_paid" | "paid" | "void" | "uncollectible" | "credited">; "customer_id"?: InputValue<string>; "order_id"?: InputValue<string>; "external_reference_id"?: InputValue<string>; "created_after"?: InputValue<string>; "created_before"?: InputValue<string>; "due_after"?: InputValue<string>; "due_before"?: InputValue<string>; "is_overdue"?: InputValue<boolean>; "has_amount_due"?: InputValue<boolean>; "sort_by"?: InputValue<"created_at" | "updated_at" | "due_at" | "invoice_number" | "outstanding_money">; "sort_direction"?: InputValue<"asc" | "desc">; "query"?: InputValue<string>; "Flint-Version"?: InputValue<string> }, options?: RequestOptions<"merchant" | "merchantKey">)`
7360
+ Call: `list(params?: { "page_size"?: InputValue<number>; "page_token"?: InputValue<string>; "status"?: InputValue<Array<"draft" | "open" | "partially_paid" | "paid" | "void" | "uncollectible" | "credited">>; "customer_id"?: InputValue<string>; "order_id"?: InputValue<string>; "external_reference_id"?: InputValue<string>; "created_after"?: InputValue<string>; "created_before"?: InputValue<string>; "due_after"?: InputValue<string>; "due_before"?: InputValue<string>; "is_overdue"?: InputValue<boolean>; "has_amount_due"?: InputValue<boolean>; "sort_by"?: InputValue<"created_at" | "updated_at" | "due_at" | "invoice_number" | "outstanding_money">; "sort_direction"?: InputValue<"asc" | "desc">; "query"?: InputValue<string>; "Flint-Version"?: InputValue<string> }, options?: RequestOptions<"merchant" | "merchantKey">)`
7227
7361
 
7228
7362
  Path arguments: none. Params contain flat body fields and query/header fields.
7229
7363
 
7230
- Canonical input schema (for configuration examples and HTTP fixtures): `{ "page_size"?: number; "page_token"?: string; "status"?: "draft" | "open" | "partially_paid" | "paid" | "void" | "uncollectible" | "credited"; "customer_id"?: string; "order_id"?: string; "external_reference_id"?: string; "created_after"?: string; "created_before"?: string; "due_after"?: string; "due_before"?: string; "is_overdue"?: boolean; "has_amount_due"?: boolean; "sort_by"?: "created_at" | "updated_at" | "due_at" | "invoice_number" | "outstanding_money"; "sort_direction"?: "asc" | "desc"; "query"?: string; "Flint-Version"?: string; }`
7364
+ Canonical input schema (for configuration examples and HTTP fixtures): `{ "page_size"?: number; "page_token"?: string; "status"?: Array<"draft" | "open" | "partially_paid" | "paid" | "void" | "uncollectible" | "credited">; "customer_id"?: string; "order_id"?: string; "external_reference_id"?: string; "created_after"?: string; "created_before"?: string; "due_after"?: string; "due_before"?: string; "is_overdue"?: boolean; "has_amount_due"?: boolean; "sort_by"?: "created_at" | "updated_at" | "due_at" | "invoice_number" | "outstanding_money"; "sort_direction"?: "asc" | "desc"; "query"?: string; "Flint-Version"?: string; }`
7231
7365
 
7232
7366
  Returned payload: `Array<Invoice>`
7233
7367
 
@@ -7235,7 +7369,7 @@ Returned payload: `Array<Invoice>`
7235
7369
  | --- | --- | --- | --- |
7236
7370
  | `page_size` | Optional | integer | minimum: 1. maximum: 100. |
7237
7371
  | `page_token` | Optional | string | |
7238
- | `status` | Optional | string | Values: "draft", "open", "partially_paid", "paid", "void", "uncollectible", "credited". |
7372
+ | `status` | Optional | Array of string | |
7239
7373
  | `customer_id` | Optional | string | |
7240
7374
  | `order_id` | Optional | string | |
7241
7375
  | `external_reference_id` | Optional | string | minLength: 1. maxLength: 255. |
@@ -7764,6 +7898,39 @@ Idempotency header: Idempotency-Key; retention: Use the endpoint-specific replay
7764
7898
  [Example](examples/invoices-voidResource.mjs)
7765
7899
 
7766
7900
 
7901
+ ### invoices.waiveLateFee
7902
+
7903
+ Waives the unpaid remainder of an assessed late fee. Collected money is not refunded. The reason is visible only to the merchant.
7904
+
7905
+ `POST /v1/invoices/{invoice_id}/late-fees/{invoice_late_fee_id}/waive`
7906
+
7907
+ Call: `waiveLateFee(invoice_id: InputValue<string>, invoice_late_fee_id: InputValue<string>, params: (InputValue<{ "reason": string; [key: string]: unknown; }>) & { "Idempotency-Key"?: InputValue<string>; "Flint-Version"?: InputValue<string> }, options?: RequestOptions<"merchant" | "merchantKey">)`
7908
+
7909
+ Path arguments: `path0` = `invoice_id`, `path1` = `invoice_late_fee_id`. Params contain flat body fields and query/header fields.
7910
+
7911
+ Canonical input schema (for configuration examples and HTTP fixtures): `{ "invoice_id": string; "invoice_late_fee_id": string; "Idempotency-Key"?: string; "Flint-Version"?: string; "body": { "reason": string; [key: string]: unknown; }; }`
7912
+
7913
+ Returned payload: `Invoice`
7914
+
7915
+ | Field | Presence | Type | Description |
7916
+ | --- | --- | --- | --- |
7917
+ | `invoice_id` | Required | string | |
7918
+ | `invoice_late_fee_id` | Required | string | |
7919
+ | `Idempotency-Key` | Optional | string | |
7920
+ | `Flint-Version` | Optional | string | Format: date. |
7921
+ | `body` | Required | object | |
7922
+
7923
+ Returns the payload at `data` directly. Use `waiveLateFeeWithResponse` for `body`, `meta` and `raw` without unwrapping.
7924
+
7925
+ Authentication modes: `merchant`, `merchantKey`. See [credential setup](RUNTIME.md#authentication).
7926
+
7927
+ Request options are the second argument. Default attempts: 1; maximum: 1. For mutation retries, supply a stable idempotency key and reuse it for the same business action.
7928
+
7929
+ Idempotency header: Idempotency-Key; retention: Use the endpoint-specific replay lifetime; the general Flint replay window is 24 hours unless the endpoint documents an exception.; scope: Endpoint-defined command identity. Optional idempotency key for safe retries..
7930
+
7931
+ [Example](examples/invoices-waiveLateFee.mjs)
7932
+
7933
+
7767
7934
  ## Resource: locations
7768
7935
 
7769
7936
  ### locations.create
@@ -8906,11 +9073,11 @@ Uses the customer identity fixed by the customer session. The request cannot sel
8906
9073
 
8907
9074
  `GET /v1/me/invoices`
8908
9075
 
8909
- Call: `listInvoices(params?: { "page_size"?: InputValue<number>; "page_token"?: InputValue<string>; "status"?: InputValue<"draft" | "open" | "partially_paid" | "paid" | "void" | "uncollectible" | "credited">; "order_id"?: InputValue<string>; "external_reference_id"?: InputValue<string>; "created_after"?: InputValue<string>; "created_before"?: InputValue<string>; "due_after"?: InputValue<string>; "due_before"?: InputValue<string>; "is_overdue"?: InputValue<boolean>; "has_amount_due"?: InputValue<boolean>; "sort_by"?: InputValue<"created_at" | "updated_at" | "due_at" | "invoice_number" | "outstanding_money">; "sort_direction"?: InputValue<"asc" | "desc">; "query"?: InputValue<string>; "Flint-Version"?: InputValue<string> }, options?: RequestOptions<"customer">)`
9076
+ Call: `listInvoices(params?: { "page_size"?: InputValue<number>; "page_token"?: InputValue<string>; "status"?: InputValue<Array<"draft" | "open" | "partially_paid" | "paid" | "void" | "uncollectible" | "credited">>; "order_id"?: InputValue<string>; "external_reference_id"?: InputValue<string>; "created_after"?: InputValue<string>; "created_before"?: InputValue<string>; "due_after"?: InputValue<string>; "due_before"?: InputValue<string>; "is_overdue"?: InputValue<boolean>; "has_amount_due"?: InputValue<boolean>; "sort_by"?: InputValue<"created_at" | "updated_at" | "due_at" | "invoice_number" | "outstanding_money">; "sort_direction"?: InputValue<"asc" | "desc">; "query"?: InputValue<string>; "Flint-Version"?: InputValue<string> }, options?: RequestOptions<"customer">)`
8910
9077
 
8911
9078
  Path arguments: none. Params contain flat body fields and query/header fields.
8912
9079
 
8913
- Canonical input schema (for configuration examples and HTTP fixtures): `{ "page_size"?: number; "page_token"?: string; "status"?: "draft" | "open" | "partially_paid" | "paid" | "void" | "uncollectible" | "credited"; "order_id"?: string; "external_reference_id"?: string; "created_after"?: string; "created_before"?: string; "due_after"?: string; "due_before"?: string; "is_overdue"?: boolean; "has_amount_due"?: boolean; "sort_by"?: "created_at" | "updated_at" | "due_at" | "invoice_number" | "outstanding_money"; "sort_direction"?: "asc" | "desc"; "query"?: string; "Flint-Version"?: string; }`
9080
+ Canonical input schema (for configuration examples and HTTP fixtures): `{ "page_size"?: number; "page_token"?: string; "status"?: Array<"draft" | "open" | "partially_paid" | "paid" | "void" | "uncollectible" | "credited">; "order_id"?: string; "external_reference_id"?: string; "created_after"?: string; "created_before"?: string; "due_after"?: string; "due_before"?: string; "is_overdue"?: boolean; "has_amount_due"?: boolean; "sort_by"?: "created_at" | "updated_at" | "due_at" | "invoice_number" | "outstanding_money"; "sort_direction"?: "asc" | "desc"; "query"?: string; "Flint-Version"?: string; }`
8914
9081
 
8915
9082
  Returned payload: `Array<BuyerInvoice>`
8916
9083
 
@@ -8918,7 +9085,7 @@ Returned payload: `Array<BuyerInvoice>`
8918
9085
  | --- | --- | --- | --- |
8919
9086
  | `page_size` | Optional | integer | minimum: 1. maximum: 100. |
8920
9087
  | `page_token` | Optional | string | |
8921
- | `status` | Optional | string | Values: "draft", "open", "partially_paid", "paid", "void", "uncollectible", "credited". |
9088
+ | `status` | Optional | Array of string | |
8922
9089
  | `order_id` | Optional | string | |
8923
9090
  | `external_reference_id` | Optional | string | minLength: 1. maxLength: 255. |
8924
9091
  | `created_after` | Optional | string | Format: date-time. Example: "2026-03-17T14:30:00Z". |
@@ -9059,11 +9226,11 @@ Uses the customer identity fixed by the customer session. The request cannot sel
9059
9226
 
9060
9227
  `GET /v1/me/orders`
9061
9228
 
9062
- Call: `listOrders(params?: { "page_size"?: InputValue<number>; "page_token"?: InputValue<string>; "status"?: InputValue<"open" | "closed">; "payment_status"?: InputValue<"unpaid" | "partially_paid" | "paid">; "refund_status"?: InputValue<"none" | "partially_refunded" | "refunded">; "fulfillment_status"?: InputValue<Array<"not_fulfilled" | "partially_fulfilled" | "fulfilled" | "canceled">>; "order_number"?: InputValue<string>; "external_reference_id"?: InputValue<string>; "origin"?: InputValue<"virtual_terminal" | "payment_link" | "checkout" | "api" | "subscription">; "query"?: InputValue<string>; "subscription_id"?: InputValue<string>; "return_id"?: InputValue<string>; "return_resolution_id"?: InputValue<string>; "min_amount"?: InputValue<string>; "max_amount"?: InputValue<string>; "currency"?: InputValue<string>; "sort_by"?: InputValue<"created_at" | "updated_at" | "outstanding_money" | "total">; "sort_direction"?: InputValue<"asc" | "desc">; "created_after"?: InputValue<string>; "created_before"?: InputValue<string>; "updated_after"?: InputValue<string>; "updated_before"?: InputValue<string>; "Flint-Version"?: InputValue<string> }, options?: RequestOptions<"customer">)`
9229
+ Call: `listOrders(params?: { "page_size"?: InputValue<number>; "page_token"?: InputValue<string>; "status"?: InputValue<"open" | "closed">; "payment_status"?: InputValue<"unpaid" | "partially_paid" | "paid">; "refund_status"?: InputValue<Array<"none" | "partially_refunded" | "refunded">>; "fulfillment_status"?: InputValue<Array<"not_fulfilled" | "partially_fulfilled" | "fulfilled" | "canceled">>; "order_number"?: InputValue<string>; "external_reference_id"?: InputValue<string>; "origin"?: InputValue<"virtual_terminal" | "payment_link" | "checkout" | "api" | "subscription">; "query"?: InputValue<string>; "subscription_id"?: InputValue<string>; "return_id"?: InputValue<string>; "return_resolution_id"?: InputValue<string>; "min_amount"?: InputValue<string>; "max_amount"?: InputValue<string>; "currency"?: InputValue<string>; "sort_by"?: InputValue<"created_at" | "updated_at" | "outstanding_money" | "total">; "sort_direction"?: InputValue<"asc" | "desc">; "created_after"?: InputValue<string>; "created_before"?: InputValue<string>; "updated_after"?: InputValue<string>; "updated_before"?: InputValue<string>; "Flint-Version"?: InputValue<string> }, options?: RequestOptions<"customer">)`
9063
9230
 
9064
9231
  Path arguments: none. Params contain flat body fields and query/header fields.
9065
9232
 
9066
- Canonical input schema (for configuration examples and HTTP fixtures): `{ "page_size"?: number; "page_token"?: string; "status"?: "open" | "closed"; "payment_status"?: "unpaid" | "partially_paid" | "paid"; "refund_status"?: "none" | "partially_refunded" | "refunded"; "fulfillment_status"?: Array<"not_fulfilled" | "partially_fulfilled" | "fulfilled" | "canceled">; "order_number"?: string; "external_reference_id"?: string; "origin"?: "virtual_terminal" | "payment_link" | "checkout" | "api" | "subscription"; "query"?: string; "subscription_id"?: string; "return_id"?: string; "return_resolution_id"?: string; "min_amount"?: string; "max_amount"?: string; "currency"?: string; "sort_by"?: "created_at" | "updated_at" | "outstanding_money" | "total"; "sort_direction"?: "asc" | "desc"; "created_after"?: string; "created_before"?: string; "updated_after"?: string; "updated_before"?: string; "Flint-Version"?: string; }`
9233
+ Canonical input schema (for configuration examples and HTTP fixtures): `{ "page_size"?: number; "page_token"?: string; "status"?: "open" | "closed"; "payment_status"?: "unpaid" | "partially_paid" | "paid"; "refund_status"?: Array<"none" | "partially_refunded" | "refunded">; "fulfillment_status"?: Array<"not_fulfilled" | "partially_fulfilled" | "fulfilled" | "canceled">; "order_number"?: string; "external_reference_id"?: string; "origin"?: "virtual_terminal" | "payment_link" | "checkout" | "api" | "subscription"; "query"?: string; "subscription_id"?: string; "return_id"?: string; "return_resolution_id"?: string; "min_amount"?: string; "max_amount"?: string; "currency"?: string; "sort_by"?: "created_at" | "updated_at" | "outstanding_money" | "total"; "sort_direction"?: "asc" | "desc"; "created_after"?: string; "created_before"?: string; "updated_after"?: string; "updated_before"?: string; "Flint-Version"?: string; }`
9067
9234
 
9068
9235
  Returned payload: `Array<Order>`
9069
9236
 
@@ -9073,7 +9240,7 @@ Returned payload: `Array<Order>`
9073
9240
  | `page_token` | Optional | string | |
9074
9241
  | `status` | Optional | string | Values: "open", "closed". |
9075
9242
  | `payment_status` | Optional | string | Values: "unpaid", "partially_paid", "paid". |
9076
- | `refund_status` | Optional | string | Values: "none", "partially_refunded", "refunded". |
9243
+ | `refund_status` | Optional | Array of string | |
9077
9244
  | `fulfillment_status` | Optional | Array of string | |
9078
9245
  | `order_number` | Optional | string | |
9079
9246
  | `external_reference_id` | Optional | string | minLength: 1. maxLength: 255. |
@@ -9636,11 +9803,11 @@ Uses the customer identity fixed by the customer session. The request cannot sel
9636
9803
 
9637
9804
  `GET /v1/me/subscriptions`
9638
9805
 
9639
- Call: `listSubscriptions(params?: { "page_size"?: InputValue<number>; "page_token"?: InputValue<string>; "status"?: InputValue<"trialing" | "active" | "paused" | "past_due" | "canceled" | "incomplete">; "billing_schedule_owner"?: InputValue<"flint" | "external">; "awaiting_billing_schedule"?: InputValue<boolean>; "plan_id"?: InputValue<string>; "sort_by"?: InputValue<"created_at" | "updated_at" | "next_billing_at">; "sort_direction"?: InputValue<"asc" | "desc">; "created_after"?: InputValue<string>; "created_before"?: InputValue<string>; "updated_after"?: InputValue<string>; "updated_before"?: InputValue<string>; "next_billing_at_after"?: InputValue<string>; "next_billing_at_before"?: InputValue<string>; "Flint-Version"?: InputValue<string> }, options?: RequestOptions<"customer">)`
9806
+ Call: `listSubscriptions(params?: { "page_size"?: InputValue<number>; "page_token"?: InputValue<string>; "status"?: InputValue<Array<"trialing" | "active" | "paused" | "past_due" | "canceled" | "incomplete">>; "billing_schedule_owner"?: InputValue<"flint" | "external">; "awaiting_billing_schedule"?: InputValue<boolean>; "cancel_at_period_end"?: InputValue<boolean>; "plan_id"?: InputValue<string>; "sort_by"?: InputValue<"created_at" | "updated_at" | "next_billing_at">; "sort_direction"?: InputValue<"asc" | "desc">; "created_after"?: InputValue<string>; "created_before"?: InputValue<string>; "updated_after"?: InputValue<string>; "updated_before"?: InputValue<string>; "next_billing_at_after"?: InputValue<string>; "next_billing_at_before"?: InputValue<string>; "needs_attention"?: InputValue<boolean>; "Flint-Version"?: InputValue<string> }, options?: RequestOptions<"customer">)`
9640
9807
 
9641
9808
  Path arguments: none. Params contain flat body fields and query/header fields.
9642
9809
 
9643
- Canonical input schema (for configuration examples and HTTP fixtures): `{ "page_size"?: number; "page_token"?: string; "status"?: "trialing" | "active" | "paused" | "past_due" | "canceled" | "incomplete"; "billing_schedule_owner"?: "flint" | "external"; "awaiting_billing_schedule"?: boolean; "plan_id"?: string; "sort_by"?: "created_at" | "updated_at" | "next_billing_at"; "sort_direction"?: "asc" | "desc"; "created_after"?: string; "created_before"?: string; "updated_after"?: string; "updated_before"?: string; "next_billing_at_after"?: string; "next_billing_at_before"?: string; "Flint-Version"?: string; }`
9810
+ Canonical input schema (for configuration examples and HTTP fixtures): `{ "page_size"?: number; "page_token"?: string; "status"?: Array<"trialing" | "active" | "paused" | "past_due" | "canceled" | "incomplete">; "billing_schedule_owner"?: "flint" | "external"; "awaiting_billing_schedule"?: boolean; "cancel_at_period_end"?: boolean; "plan_id"?: string; "sort_by"?: "created_at" | "updated_at" | "next_billing_at"; "sort_direction"?: "asc" | "desc"; "created_after"?: string; "created_before"?: string; "updated_after"?: string; "updated_before"?: string; "next_billing_at_after"?: string; "next_billing_at_before"?: string; "needs_attention"?: boolean; "Flint-Version"?: string; }`
9644
9811
 
9645
9812
  Returned payload: `Array<Subscription>`
9646
9813
 
@@ -9648,9 +9815,10 @@ Returned payload: `Array<Subscription>`
9648
9815
  | --- | --- | --- | --- |
9649
9816
  | `page_size` | Optional | integer | minimum: 1. maximum: 100. |
9650
9817
  | `page_token` | Optional | string | |
9651
- | `status` | Optional | string | Values: "trialing", "active", "paused", "past_due", "canceled", "incomplete". |
9818
+ | `status` | Optional | Array of string | |
9652
9819
  | `billing_schedule_owner` | Optional | string | Values: "flint", "external". |
9653
9820
  | `awaiting_billing_schedule` | Optional | boolean | |
9821
+ | `cancel_at_period_end` | Optional | boolean | |
9654
9822
  | `plan_id` | Optional | string | |
9655
9823
  | `sort_by` | Optional | string | Values: "created_at", "updated_at", "next_billing_at". |
9656
9824
  | `sort_direction` | Optional | string | Values: "asc", "desc". |
@@ -9660,6 +9828,7 @@ Returned payload: `Array<Subscription>`
9660
9828
  | `updated_before` | Optional | string | Format: date-time. Example: "2026-03-17T14:30:00Z". |
9661
9829
  | `next_billing_at_after` | Optional | string | Format: date-time. Example: "2026-03-17T14:30:00Z". |
9662
9830
  | `next_billing_at_before` | Optional | string | Format: date-time. Example: "2026-03-17T14:30:00Z". |
9831
+ | `needs_attention` | Optional | boolean | |
9663
9832
  | `Flint-Version` | Optional | string | Format: date. |
9664
9833
 
9665
9834
  Returns the payload at `data` directly. Use `listSubscriptionsWithResponse` for `body`, `meta` and `raw` without unwrapping.
@@ -10762,7 +10931,7 @@ Request options are the second argument. Default attempts: 1; maximum: 1.
10762
10931
 
10763
10932
  ### oauth.exchangePartnerInstallToken
10764
10933
 
10765
- Exchanges an authorization code or refresh token for an installation-scoped bearer token. This endpoint follows OAuth token endpoint conventions: it accepts application/x-www-form-urlencoded requests as well as JSON and returns OAuth token error objects for token exchange failures instead of the normal Flint error envelope.
10934
+ Exchanges an authorization code or refresh token for an installation-scoped bearer token. This endpoint follows OAuth token endpoint conventions: it accepts application/x-www-form-urlencoded requests as well as JSON and returns OAuth token error objects for token exchange failures instead of the normal Flint error envelope. The public client flint-cli also supports the RFC 8628 device_code grant and rotating refresh tokens using form requests. Pending device requests return authorization_pending; early polling returns slow_down and increases the required interval by five seconds; denial returns access_denied; expired or consumed codes return expired_token. Access tokens last 15 minutes. CLI sessions expire after 30 days idle or 90 days total. Reusing a rotated refresh token revokes its family, including when the previous response was lost. A fresh browser login is then required. With session_mode=contexts at authorization, tokens include oauth_session_id and context_id. Refresh requires an explicitly authorized context_id; invalid_context and context_access_denied do not consume the refresh token. Each access token is limited to one context. Ordinary rotation preserves other unexpired access tokens; removing consent immediately invalidates affected tokens. Legacy sessions retain their original response and authorization semantics.
10766
10935
 
10767
10936
  `POST /v1/oauth/token`
10768
10937
 
@@ -10772,7 +10941,7 @@ Path arguments: none. Params contain flat body fields and query/header fields.
10772
10941
 
10773
10942
  Canonical input schema (for configuration examples and HTTP fixtures): `{ "Flint-Version"?: string; "body": { "client_id": string; "client_secret": string; "code"?: string; "grant_type": string; "redirect_uri"?: string; "refresh_token"?: string; [key: string]: unknown; }; }`
10774
10943
 
10775
- Returned payload: `{ "access_token": string; "environment_grant_id": string; "expires_in": string; "merchant_id": string; "mode": "test" | "live" | (string & {}); "partner_app_id": string; "partner_app_install_id": string; "refresh_token"?: string; "scope"?: string; "token_type": string; [key: string]: unknown; }`
10944
+ Returned payload: `(({ "access_token": string; "environment_grant_id": string; "expires_in": string; "merchant_id": string; "mode": "test" | "live" | (string & {}); "partner_app_id": string; "partner_app_install_id": string; "refresh_token"?: string; "scope"?: string; "token_type": string; [key: string]: unknown; }) | (({ "access_token": string; "context_id"?: string; "expires_in": number; "oauth_session_id"?: string; "refresh_token": string; "scope": string; "token_type": "Bearer" | (string & {}); [key: string]: unknown; })) | ({ [key: string]: unknown }))`
10776
10945
 
10777
10946
  | Field | Presence | Type | Description |
10778
10947
  | --- | --- | --- | --- |
@@ -11480,11 +11649,11 @@ Returns a paginated list of orders for the authenticated merchant.
11480
11649
 
11481
11650
  `GET /v1/orders`
11482
11651
 
11483
- Call: `list(params?: { "page_size"?: InputValue<number>; "page_token"?: InputValue<string>; "customer_id"?: InputValue<string>; "status"?: InputValue<"open" | "closed">; "payment_status"?: InputValue<"unpaid" | "partially_paid" | "paid">; "refund_status"?: InputValue<"none" | "partially_refunded" | "refunded">; "fulfillment_status"?: InputValue<Array<"not_fulfilled" | "partially_fulfilled" | "fulfilled" | "canceled">>; "order_number"?: InputValue<string>; "external_reference_id"?: InputValue<string>; "origin"?: InputValue<"virtual_terminal" | "payment_link" | "checkout" | "api" | "subscription">; "query"?: InputValue<string>; "subscription_id"?: InputValue<string>; "return_id"?: InputValue<string>; "return_resolution_id"?: InputValue<string>; "min_amount"?: InputValue<string>; "max_amount"?: InputValue<string>; "currency"?: InputValue<string>; "sort_by"?: InputValue<"created_at" | "updated_at" | "outstanding_money" | "total">; "sort_direction"?: InputValue<"asc" | "desc">; "created_after"?: InputValue<string>; "created_before"?: InputValue<string>; "updated_after"?: InputValue<string>; "updated_before"?: InputValue<string>; "Flint-Version"?: InputValue<string> }, options?: RequestOptions<"merchant" | "merchantKey">)`
11652
+ Call: `list(params?: { "page_size"?: InputValue<number>; "page_token"?: InputValue<string>; "customer_id"?: InputValue<string>; "status"?: InputValue<"open" | "closed">; "payment_status"?: InputValue<"unpaid" | "partially_paid" | "paid">; "refund_status"?: InputValue<Array<"none" | "partially_refunded" | "refunded">>; "fulfillment_status"?: InputValue<Array<"not_fulfilled" | "partially_fulfilled" | "fulfilled" | "canceled">>; "order_number"?: InputValue<string>; "external_reference_id"?: InputValue<string>; "origin"?: InputValue<"virtual_terminal" | "payment_link" | "checkout" | "api" | "subscription">; "query"?: InputValue<string>; "subscription_id"?: InputValue<string>; "return_id"?: InputValue<string>; "return_resolution_id"?: InputValue<string>; "min_amount"?: InputValue<string>; "max_amount"?: InputValue<string>; "currency"?: InputValue<string>; "sort_by"?: InputValue<"created_at" | "updated_at" | "outstanding_money" | "total">; "sort_direction"?: InputValue<"asc" | "desc">; "created_after"?: InputValue<string>; "created_before"?: InputValue<string>; "updated_after"?: InputValue<string>; "updated_before"?: InputValue<string>; "Flint-Version"?: InputValue<string> }, options?: RequestOptions<"merchant" | "merchantKey">)`
11484
11653
 
11485
11654
  Path arguments: none. Params contain flat body fields and query/header fields.
11486
11655
 
11487
- Canonical input schema (for configuration examples and HTTP fixtures): `{ "page_size"?: number; "page_token"?: string; "customer_id"?: string; "status"?: "open" | "closed"; "payment_status"?: "unpaid" | "partially_paid" | "paid"; "refund_status"?: "none" | "partially_refunded" | "refunded"; "fulfillment_status"?: Array<"not_fulfilled" | "partially_fulfilled" | "fulfilled" | "canceled">; "order_number"?: string; "external_reference_id"?: string; "origin"?: "virtual_terminal" | "payment_link" | "checkout" | "api" | "subscription"; "query"?: string; "subscription_id"?: string; "return_id"?: string; "return_resolution_id"?: string; "min_amount"?: string; "max_amount"?: string; "currency"?: string; "sort_by"?: "created_at" | "updated_at" | "outstanding_money" | "total"; "sort_direction"?: "asc" | "desc"; "created_after"?: string; "created_before"?: string; "updated_after"?: string; "updated_before"?: string; "Flint-Version"?: string; }`
11656
+ Canonical input schema (for configuration examples and HTTP fixtures): `{ "page_size"?: number; "page_token"?: string; "customer_id"?: string; "status"?: "open" | "closed"; "payment_status"?: "unpaid" | "partially_paid" | "paid"; "refund_status"?: Array<"none" | "partially_refunded" | "refunded">; "fulfillment_status"?: Array<"not_fulfilled" | "partially_fulfilled" | "fulfilled" | "canceled">; "order_number"?: string; "external_reference_id"?: string; "origin"?: "virtual_terminal" | "payment_link" | "checkout" | "api" | "subscription"; "query"?: string; "subscription_id"?: string; "return_id"?: string; "return_resolution_id"?: string; "min_amount"?: string; "max_amount"?: string; "currency"?: string; "sort_by"?: "created_at" | "updated_at" | "outstanding_money" | "total"; "sort_direction"?: "asc" | "desc"; "created_after"?: string; "created_before"?: string; "updated_after"?: string; "updated_before"?: string; "Flint-Version"?: string; }`
11488
11657
 
11489
11658
  Returned payload: `Array<Order>`
11490
11659
 
@@ -11495,7 +11664,7 @@ Returned payload: `Array<Order>`
11495
11664
  | `customer_id` | Optional | string | |
11496
11665
  | `status` | Optional | string | Values: "open", "closed". |
11497
11666
  | `payment_status` | Optional | string | Values: "unpaid", "partially_paid", "paid". |
11498
- | `refund_status` | Optional | string | Values: "none", "partially_refunded", "refunded". |
11667
+ | `refund_status` | Optional | Array of string | |
11499
11668
  | `fulfillment_status` | Optional | Array of string | |
11500
11669
  | `order_number` | Optional | string | |
11501
11670
  | `external_reference_id` | Optional | string | minLength: 1. maxLength: 255. |
@@ -14649,11 +14818,11 @@ Returns a paginated list of promotions for the authenticated merchant.
14649
14818
 
14650
14819
  `GET /v1/promotions`
14651
14820
 
14652
- Call: `list(params?: { "page_size"?: InputValue<number>; "page_token"?: InputValue<string>; "status"?: InputValue<"active" | "inactive" | "expired" | "not_yet_started" | "exhausted" | "no_active_codes" | "archived">; "external_reference_id"?: InputValue<string>; "query"?: InputValue<string>; "product_id"?: InputValue<string>; "variant_id"?: InputValue<string>; "bundle_id"?: InputValue<string>; "category_handle"?: InputValue<string>; "redemption_type"?: InputValue<"automatic" | "code">; "discount_class"?: InputValue<"order" | "line_item" | "service_charge">; "sort_by"?: InputValue<"name" | "created_at" | "updated_at">; "sort_direction"?: InputValue<"asc" | "desc">; "created_after"?: InputValue<string>; "created_before"?: InputValue<string>; "updated_after"?: InputValue<string>; "updated_before"?: InputValue<string>; "Flint-Version"?: InputValue<string> }, options?: RequestOptions<"merchant" | "merchantKey">)`
14821
+ Call: `list(params?: { "page_size"?: InputValue<number>; "page_token"?: InputValue<string>; "status"?: InputValue<Array<"active" | "inactive" | "expired" | "not_yet_started" | "exhausted" | "no_active_codes" | "archived">>; "external_reference_id"?: InputValue<string>; "query"?: InputValue<string>; "product_id"?: InputValue<string>; "variant_id"?: InputValue<string>; "bundle_id"?: InputValue<string>; "category_handle"?: InputValue<string>; "redemption_type"?: InputValue<"automatic" | "code">; "discount_class"?: InputValue<"order" | "line_item" | "service_charge">; "sort_by"?: InputValue<"name" | "created_at" | "updated_at">; "sort_direction"?: InputValue<"asc" | "desc">; "created_after"?: InputValue<string>; "created_before"?: InputValue<string>; "updated_after"?: InputValue<string>; "updated_before"?: InputValue<string>; "Flint-Version"?: InputValue<string> }, options?: RequestOptions<"merchant" | "merchantKey">)`
14653
14822
 
14654
14823
  Path arguments: none. Params contain flat body fields and query/header fields.
14655
14824
 
14656
- Canonical input schema (for configuration examples and HTTP fixtures): `{ "page_size"?: number; "page_token"?: string; "status"?: "active" | "inactive" | "expired" | "not_yet_started" | "exhausted" | "no_active_codes" | "archived"; "external_reference_id"?: string; "query"?: string; "product_id"?: string; "variant_id"?: string; "bundle_id"?: string; "category_handle"?: string; "redemption_type"?: "automatic" | "code"; "discount_class"?: "order" | "line_item" | "service_charge"; "sort_by"?: "name" | "created_at" | "updated_at"; "sort_direction"?: "asc" | "desc"; "created_after"?: string; "created_before"?: string; "updated_after"?: string; "updated_before"?: string; "Flint-Version"?: string; }`
14825
+ Canonical input schema (for configuration examples and HTTP fixtures): `{ "page_size"?: number; "page_token"?: string; "status"?: Array<"active" | "inactive" | "expired" | "not_yet_started" | "exhausted" | "no_active_codes" | "archived">; "external_reference_id"?: string; "query"?: string; "product_id"?: string; "variant_id"?: string; "bundle_id"?: string; "category_handle"?: string; "redemption_type"?: "automatic" | "code"; "discount_class"?: "order" | "line_item" | "service_charge"; "sort_by"?: "name" | "created_at" | "updated_at"; "sort_direction"?: "asc" | "desc"; "created_after"?: string; "created_before"?: string; "updated_after"?: string; "updated_before"?: string; "Flint-Version"?: string; }`
14657
14826
 
14658
14827
  Returned payload: `Array<Promotion>`
14659
14828
 
@@ -14661,7 +14830,7 @@ Returned payload: `Array<Promotion>`
14661
14830
  | --- | --- | --- | --- |
14662
14831
  | `page_size` | Optional | integer | minimum: 1. maximum: 100. |
14663
14832
  | `page_token` | Optional | string | |
14664
- | `status` | Optional | string | Values: "active", "inactive", "expired", "not_yet_started", "exhausted", "no_active_codes", "archived". |
14833
+ | `status` | Optional | Array of string | |
14665
14834
  | `external_reference_id` | Optional | string | minLength: 1. maxLength: 255. |
14666
14835
  | `query` | Optional | string | |
14667
14836
  | `product_id` | Optional | string | |
@@ -18029,11 +18198,11 @@ Applies a sparse patch to merchant-scoped settings. Send catalog by itself becau
18029
18198
 
18030
18199
  `PATCH /v1/settings`
18031
18200
 
18032
- Call: `update(params: (InputValue<({ "branding"?: BrandingSettingsInput; "catalog"?: UpdateCatalogSettingsInput; "checkout"?: CheckoutSettingsInput; "customer_account"?: CustomerAccountSettingsInput; "customer_email_delivery"?: CustomerEmailDeliverySettingsInput; "fulfillment"?: FulfillmentSettingsInput; "inventory"?: InventorySettingsInput; "invoices"?: (({ "autopay_retry_policy"?: (({ "retry_day_offsets": Array<number>; }) | (null)); "credit_note_number_prefix"?: string | null; "default_collection_mode"?: "buyer_initiated" | "automatic" | "external" | null; "default_footer"?: string | null; "default_invoice_payment_term_id"?: string | null; "default_memo"?: string | null; "invoice_number_prefix"?: string | null; "payment_policy"?: (({ "enabled_payment_options": Array<"card" | "apple_pay" | "google_pay" | "affirm" | "ach_debit">; "payment_option_limits"?: Array<InvoicePaymentOptionLimitInput>; "show_cost_comparison"?: boolean; }) | (null)); "reminder_policy"?: (({ "rules": Array<InvoiceReminderRuleInput>; }) | (null)); "remit_to_address"?: (({ "city": string; "country": string; "line1": string; "line2"?: string; "postal_code": string; "state": string; [key: string]: unknown; }) | (null)); "reply_to_email"?: string | null; "timezone"?: string | null; }) | (null)); "legal"?: LegalSettingsInput; "metadata"?: Record<string, string | null> | null; "promotions"?: PromotionSettingsInput; "receipts"?: ReceiptSettingsInput; "subscriptions"?: SubscriptionSettingsInput; "tax"?: TaxSettingsInput; "tipping"?: TippingSettingsInput; [key: string]: unknown; })>) & { "Idempotency-Key"?: InputValue<string>; "X-Request-Id"?: InputValue<string>; "Flint-Version"?: InputValue<string> }, options?: RequestOptions<"merchant" | "merchantKey">)`
18201
+ Call: `update(params: (InputValue<({ "branding"?: BrandingSettingsInput; "catalog"?: UpdateCatalogSettingsInput; "checkout"?: CheckoutSettingsInput; "customer_account"?: CustomerAccountSettingsInput; "customer_email_delivery"?: CustomerEmailDeliverySettingsInput; "expected_version"?: string; "fulfillment"?: FulfillmentSettingsInput; "inventory"?: InventorySettingsInput; "invoices"?: (({ "autopay_retry_policy"?: (({ "retry_day_offsets": Array<number>; }) | (null)); "credit_note_number_prefix"?: string | null; "default_collection_mode"?: "buyer_initiated" | "automatic" | "external" | null; "default_footer"?: string | null; "default_invoice_payment_term_id"?: string | null; "default_memo"?: string | null; "invoice_number_prefix"?: string | null; "payment_policy"?: (({ "enabled_payment_options": Array<"card" | "apple_pay" | "google_pay" | "affirm" | "ach_debit">; "payment_option_limits"?: Array<InvoicePaymentOptionLimitInput>; "show_cost_comparison"?: boolean; }) | (null)); "reminder_policy"?: (({ "rules": Array<InvoiceReminderRuleInput>; }) | (null)); "remit_to_address"?: (({ "city": string; "country": string; "line1": string; "line2"?: string; "postal_code": string; "state": string; [key: string]: unknown; }) | (null)); "reply_to_email"?: string | null; "timezone"?: string | null; }) | (null)); "legal"?: LegalSettingsInput; "metadata"?: Record<string, string | null> | null; "promotions"?: PromotionSettingsInput; "receipts"?: ReceiptSettingsInput; "subscriptions"?: SubscriptionSettingsInput; "tax"?: TaxSettingsInput; "tax_identity"?: (({ "legal_name"?: string | null; "registered_address"?: (({ "city": string; "country": string; "line1": string; "line2"?: string; "postal_code": string; "state": string; [key: string]: unknown; }) | (null)); "tax_ids"?: Array<DocumentTaxIDInput>; [key: string]: unknown; }) | (null)); "tipping"?: TippingSettingsPatchInput; [key: string]: unknown; })>) & { "Idempotency-Key"?: InputValue<string>; "X-Request-Id"?: InputValue<string>; "Flint-Version"?: InputValue<string> }, options?: RequestOptions<"merchant" | "merchantKey">)`
18033
18202
 
18034
18203
  Path arguments: none. Params contain flat body fields and query/header fields.
18035
18204
 
18036
- Canonical input schema (for configuration examples and HTTP fixtures): `{ "Idempotency-Key"?: string; "X-Request-Id"?: string; "Flint-Version"?: string; "body": ({ "branding"?: BrandingSettingsInput; "catalog"?: UpdateCatalogSettingsInput; "checkout"?: CheckoutSettingsInput; "customer_account"?: CustomerAccountSettingsInput; "customer_email_delivery"?: CustomerEmailDeliverySettingsInput; "fulfillment"?: FulfillmentSettingsInput; "inventory"?: InventorySettingsInput; "invoices"?: (({ "autopay_retry_policy"?: (({ "retry_day_offsets": Array<number>; }) | (null)); "credit_note_number_prefix"?: string | null; "default_collection_mode"?: "buyer_initiated" | "automatic" | "external" | null; "default_footer"?: string | null; "default_invoice_payment_term_id"?: string | null; "default_memo"?: string | null; "invoice_number_prefix"?: string | null; "payment_policy"?: (({ "enabled_payment_options": Array<"card" | "apple_pay" | "google_pay" | "affirm" | "ach_debit">; "payment_option_limits"?: Array<InvoicePaymentOptionLimitInput>; "show_cost_comparison"?: boolean; }) | (null)); "reminder_policy"?: (({ "rules": Array<InvoiceReminderRuleInput>; }) | (null)); "remit_to_address"?: (({ "city": string; "country": string; "line1": string; "line2"?: string; "postal_code": string; "state": string; [key: string]: unknown; }) | (null)); "reply_to_email"?: string | null; "timezone"?: string | null; }) | (null)); "legal"?: LegalSettingsInput; "metadata"?: Record<string, string | null> | null; "promotions"?: PromotionSettingsInput; "receipts"?: ReceiptSettingsInput; "subscriptions"?: SubscriptionSettingsInput; "tax"?: TaxSettingsInput; "tipping"?: TippingSettingsInput; [key: string]: unknown; }); }`
18205
+ Canonical input schema (for configuration examples and HTTP fixtures): `{ "Idempotency-Key"?: string; "X-Request-Id"?: string; "Flint-Version"?: string; "body": ({ "branding"?: BrandingSettingsInput; "catalog"?: UpdateCatalogSettingsInput; "checkout"?: CheckoutSettingsInput; "customer_account"?: CustomerAccountSettingsInput; "customer_email_delivery"?: CustomerEmailDeliverySettingsInput; "expected_version"?: string; "fulfillment"?: FulfillmentSettingsInput; "inventory"?: InventorySettingsInput; "invoices"?: (({ "autopay_retry_policy"?: (({ "retry_day_offsets": Array<number>; }) | (null)); "credit_note_number_prefix"?: string | null; "default_collection_mode"?: "buyer_initiated" | "automatic" | "external" | null; "default_footer"?: string | null; "default_invoice_payment_term_id"?: string | null; "default_memo"?: string | null; "invoice_number_prefix"?: string | null; "payment_policy"?: (({ "enabled_payment_options": Array<"card" | "apple_pay" | "google_pay" | "affirm" | "ach_debit">; "payment_option_limits"?: Array<InvoicePaymentOptionLimitInput>; "show_cost_comparison"?: boolean; }) | (null)); "reminder_policy"?: (({ "rules": Array<InvoiceReminderRuleInput>; }) | (null)); "remit_to_address"?: (({ "city": string; "country": string; "line1": string; "line2"?: string; "postal_code": string; "state": string; [key: string]: unknown; }) | (null)); "reply_to_email"?: string | null; "timezone"?: string | null; }) | (null)); "legal"?: LegalSettingsInput; "metadata"?: Record<string, string | null> | null; "promotions"?: PromotionSettingsInput; "receipts"?: ReceiptSettingsInput; "subscriptions"?: SubscriptionSettingsInput; "tax"?: TaxSettingsInput; "tax_identity"?: (({ "legal_name"?: string | null; "registered_address"?: (({ "city": string; "country": string; "line1": string; "line2"?: string; "postal_code": string; "state": string; [key: string]: unknown; }) | (null)); "tax_ids"?: Array<DocumentTaxIDInput>; [key: string]: unknown; }) | (null)); "tipping"?: TippingSettingsPatchInput; [key: string]: unknown; }); }`
18037
18206
 
18038
18207
  Returned payload: `Settings`
18039
18208
 
@@ -18677,11 +18846,11 @@ Returns a paginated list of subscriptions for the authenticated merchant.
18677
18846
 
18678
18847
  `GET /v1/subscriptions`
18679
18848
 
18680
- Call: `list(params?: { "page_size"?: InputValue<number>; "page_token"?: InputValue<string>; "status"?: InputValue<"trialing" | "active" | "paused" | "past_due" | "canceled" | "incomplete">; "billing_schedule_owner"?: InputValue<"flint" | "external">; "awaiting_billing_schedule"?: InputValue<boolean>; "customer_id"?: InputValue<string>; "plan_id"?: InputValue<string>; "external_reference_id"?: InputValue<string>; "query"?: InputValue<string>; "sort_by"?: InputValue<"created_at" | "updated_at" | "next_billing_at">; "sort_direction"?: InputValue<"asc" | "desc">; "created_after"?: InputValue<string>; "created_before"?: InputValue<string>; "updated_after"?: InputValue<string>; "updated_before"?: InputValue<string>; "next_billing_at_after"?: InputValue<string>; "next_billing_at_before"?: InputValue<string>; "Flint-Version"?: InputValue<string> }, options?: RequestOptions<"merchant" | "merchantKey">)`
18849
+ Call: `list(params?: { "page_size"?: InputValue<number>; "page_token"?: InputValue<string>; "status"?: InputValue<Array<"trialing" | "active" | "paused" | "past_due" | "canceled" | "incomplete">>; "billing_schedule_owner"?: InputValue<"flint" | "external">; "awaiting_billing_schedule"?: InputValue<boolean>; "cancel_at_period_end"?: InputValue<boolean>; "customer_id"?: InputValue<string>; "plan_id"?: InputValue<string>; "external_reference_id"?: InputValue<string>; "query"?: InputValue<string>; "sort_by"?: InputValue<"created_at" | "updated_at" | "next_billing_at">; "sort_direction"?: InputValue<"asc" | "desc">; "created_after"?: InputValue<string>; "created_before"?: InputValue<string>; "updated_after"?: InputValue<string>; "updated_before"?: InputValue<string>; "next_billing_at_after"?: InputValue<string>; "next_billing_at_before"?: InputValue<string>; "needs_attention"?: InputValue<boolean>; "expand"?: InputValue<Array<"customer" | "subscription_plan">>; "Flint-Version"?: InputValue<string> }, options?: RequestOptions<"merchant" | "merchantKey">)`
18681
18850
 
18682
18851
  Path arguments: none. Params contain flat body fields and query/header fields.
18683
18852
 
18684
- Canonical input schema (for configuration examples and HTTP fixtures): `{ "page_size"?: number; "page_token"?: string; "status"?: "trialing" | "active" | "paused" | "past_due" | "canceled" | "incomplete"; "billing_schedule_owner"?: "flint" | "external"; "awaiting_billing_schedule"?: boolean; "customer_id"?: string; "plan_id"?: string; "external_reference_id"?: string; "query"?: string; "sort_by"?: "created_at" | "updated_at" | "next_billing_at"; "sort_direction"?: "asc" | "desc"; "created_after"?: string; "created_before"?: string; "updated_after"?: string; "updated_before"?: string; "next_billing_at_after"?: string; "next_billing_at_before"?: string; "Flint-Version"?: string; }`
18853
+ Canonical input schema (for configuration examples and HTTP fixtures): `{ "page_size"?: number; "page_token"?: string; "status"?: Array<"trialing" | "active" | "paused" | "past_due" | "canceled" | "incomplete">; "billing_schedule_owner"?: "flint" | "external"; "awaiting_billing_schedule"?: boolean; "cancel_at_period_end"?: boolean; "customer_id"?: string; "plan_id"?: string; "external_reference_id"?: string; "query"?: string; "sort_by"?: "created_at" | "updated_at" | "next_billing_at"; "sort_direction"?: "asc" | "desc"; "created_after"?: string; "created_before"?: string; "updated_after"?: string; "updated_before"?: string; "next_billing_at_after"?: string; "next_billing_at_before"?: string; "needs_attention"?: boolean; "expand"?: Array<"customer" | "subscription_plan">; "Flint-Version"?: string; }`
18685
18854
 
18686
18855
  Returned payload: `Array<Subscription>`
18687
18856
 
@@ -18689,9 +18858,10 @@ Returned payload: `Array<Subscription>`
18689
18858
  | --- | --- | --- | --- |
18690
18859
  | `page_size` | Optional | integer | minimum: 1. maximum: 100. |
18691
18860
  | `page_token` | Optional | string | |
18692
- | `status` | Optional | string | Values: "trialing", "active", "paused", "past_due", "canceled", "incomplete". |
18861
+ | `status` | Optional | Array of string | |
18693
18862
  | `billing_schedule_owner` | Optional | string | Values: "flint", "external". |
18694
18863
  | `awaiting_billing_schedule` | Optional | boolean | |
18864
+ | `cancel_at_period_end` | Optional | boolean | |
18695
18865
  | `customer_id` | Optional | string | |
18696
18866
  | `plan_id` | Optional | string | |
18697
18867
  | `external_reference_id` | Optional | string | minLength: 1. maxLength: 255. |
@@ -18704,6 +18874,8 @@ Returned payload: `Array<Subscription>`
18704
18874
  | `updated_before` | Optional | string | Format: date-time. Example: "2026-03-17T14:30:00Z". |
18705
18875
  | `next_billing_at_after` | Optional | string | Format: date-time. Example: "2026-03-17T14:30:00Z". |
18706
18876
  | `next_billing_at_before` | Optional | string | Format: date-time. Example: "2026-03-17T14:30:00Z". |
18877
+ | `needs_attention` | Optional | boolean | |
18878
+ | `expand` | Optional | Array of string | |
18707
18879
  | `Flint-Version` | Optional | string | Format: date. |
18708
18880
 
18709
18881
  Returns the payload at `data` directly. Use `listWithResponse` for `body`, `meta` and `raw` without unwrapping.
@@ -19160,11 +19332,11 @@ Creates and delivers a synthetic test webhook event to one active webhook endpoi
19160
19332
 
19161
19333
  `POST /v1/webhook-endpoints/{webhook_endpoint_id}/test-events`
19162
19334
 
19163
- Call: `createWebhookTestEvent(webhook_endpoint_id: InputValue<string>, params: (InputValue<{ "event_type": "balance.updated" | "balance_transaction.created" | "balance_transaction.updated" | "capability.updated" | "checkout_session.completed" | "checkout_session.closed" | "checkout_session.expired" | "checkout_session.invalidated" | "credit_note.allocation_created" | "credit_note.allocation_reversed" | "credit_note.created" | "credit_note.issued" | "credit_note.updated" | "credit_note.voided" | "customer.created" | "customer.deletion_completed" | "customer.deletion_rejected" | "customer.deletion_requested" | "customer.updated" | "dispute.closed" | "dispute.created" | "dispute.lost" | "dispute.needs_response" | "dispute.prevented" | "dispute.updated" | "dispute.warning_closed" | "dispute.won" | "fraud_warning.created" | "fraud_warning.updated" | "delivery_rate_callback.archived" | "delivery_rate_callback.created" | "delivery_rate_callback.deactivated" | "delivery_rate_callback.activated" | "delivery_rate_callback.updated" | "delivery_method.archived" | "delivery_method.created" | "delivery_method.deactivated" | "delivery_method.activated" | "delivery_method.updated" | "delivery_location_set.archived" | "delivery_location_set.created" | "delivery_location_set.deactivated" | "delivery_location_set.activated" | "delivery_location_set.updated" | "delivery_profile.archived" | "delivery_profile.created" | "delivery_profile.deactivated" | "delivery_profile.activated" | "delivery_profile.updated" | "delivery_rate.archived" | "delivery_rate.created" | "delivery_rate.updated" | "delivery_revocation.created" | "delivery_selection.committed" | "delivery_zone.archived" | "delivery_zone.created" | "delivery_zone.deactivated" | "delivery_zone.activated" | "delivery_zone.updated" | "invoice.collection_block_resolved" | "invoice.collection_blocked" | "invoice.credited" | "invoice.created" | "invoice.delivery_failed" | "invoice.delivery_succeeded" | "invoice.issued" | "invoice.issue_failed" | "invoice.late_fee_due" | "invoice.marked_uncollectible" | "invoice.manual_payment_recorded" | "invoice.manual_payment_reversed" | "invoice.overdue" | "invoice.paid" | "invoice.payment_processing" | "invoice.payment_attempt_canceled" | "invoice.payment_attempt_expired" | "invoice.payment_failed" | "invoice.partially_paid" | "invoice.partially_refunded" | "invoice.refunded" | "invoice.reminder_due" | "invoice.sent" | "invoice.updated" | "invoice.voided" | "inventory.action_required" | "inventory.count.applied" | "inventory.level.updated" | "inventory.receipt.created" | "inventory.reservation.at_risk" | "inventory.reservation.closed" | "inventory.reservation.committed" | "inventory.reservation.consumed" | "inventory.reservation.created" | "inventory.reservation.hold_expired" | "inventory.reservation.released" | "inventory.shortage.detected" | "inventory.transfer.closed" | "inventory.transfer.departed" | "inventory.transfer.lost" | "inventory.transfer.received" | "inventory.transfer.returned" | "merchant_billing_balance.updated" | "merchant.readiness.updated" | "merchant_subscription_invoice.issued" | "merchant_subscription_invoice.updated" | "order.closed" | "order.created" | "order.fulfillment.completed" | "order.fulfillment.created" | "order.fulfillment.event.created" | "order.fulfillment.package.created" | "order.fulfillment.package.updated" | "order.fulfillment.shipment.created" | "order.fulfillment.shipment.updated" | "order.fulfillment.status_changed" | "order.fulfillment.updated" | "order.inventory_action_required" | "order.inventory_exception.created" | "order.inventory_exception.resolved" | "order.payment_authorization_expired" | "order.payment_authorization_canceled" | "order.payment_authorized" | "order.payment_captured" | "order.partially_paid" | "order.paid" | "order.refunded" | "order.updated" | "payment_intent.canceled" | "payment_intent.fulfillment_hold.updated" | "payment_intent.payment_failed" | "payment_intent.processing" | "payment_intent.requires_action" | "payment_intent.requires_capture" | "payment_intent.succeeded" | "payment_method.failed" | "payment_method.removed" | "payment_method.saved" | "payout.canceled" | "payout.created" | "payout.failed" | "payout.paid" | "payout.reversed" | "payout.updated" | "payout_destination.created" | "payout_destination.deleted" | "payout_destination.disabled" | "payout_destination.updated" | "payout_settings.updated" | "refund.created" | "refund.failed" | "refund.updated" | "report.failed" | "report.succeeded" | "return.canceled" | "return.completed" | "return.created" | "return.decision_recorded" | "return.reopened" | "return.updated" | "return_disposition.created" | "return_disposition.updated" | "return_inspection.acceptance_decided" | "return_inspection.created" | "return_inspection.superseded" | "return_receipt.created" | "return_receipt.superseded" | "return_receipt.verified" | "return_resolution.created" | "return_resolution.updated" | "review.closed" | "review.opened" | "subscription.activated" | "subscription.canceled" | "subscription.created" | "subscription.dunning_exhausted" | "subscription.past_due" | "subscription.paused" | "subscription.payment_failed" | "subscription.payment_succeeded" | "subscription.resumed" | "subscription.renewal_upcoming" | "subscription.trial_ending" | "subscription.updated"; [key: string]: unknown; }>) & { "Idempotency-Key"?: InputValue<string>; "Flint-Version"?: InputValue<string> }, options?: RequestOptions<"merchant" | "merchantKey">)`
19335
+ Call: `createWebhookTestEvent(webhook_endpoint_id: InputValue<string>, params: (InputValue<{ "event_type": "balance.updated" | "balance_transaction.created" | "balance_transaction.updated" | "capability.updated" | "checkout_session.completed" | "checkout_session.closed" | "checkout_session.expired" | "checkout_session.invalidated" | "credit_note.allocation_created" | "credit_note.allocation_reversed" | "credit_note.created" | "credit_note.issued" | "credit_note.updated" | "credit_note.voided" | "customer.created" | "customer.deletion_completed" | "customer.deletion_rejected" | "customer.deletion_requested" | "customer.updated" | "dispute.closed" | "dispute.created" | "dispute.lost" | "dispute.needs_response" | "dispute.prevented" | "dispute.updated" | "dispute.warning_closed" | "dispute.won" | "fraud_warning.created" | "fraud_warning.updated" | "delivery_rate_callback.archived" | "delivery_rate_callback.created" | "delivery_rate_callback.deactivated" | "delivery_rate_callback.activated" | "delivery_rate_callback.updated" | "delivery_method.archived" | "delivery_method.created" | "delivery_method.deactivated" | "delivery_method.activated" | "delivery_method.updated" | "delivery_location_set.archived" | "delivery_location_set.created" | "delivery_location_set.deactivated" | "delivery_location_set.activated" | "delivery_location_set.updated" | "delivery_profile.archived" | "delivery_profile.created" | "delivery_profile.deactivated" | "delivery_profile.activated" | "delivery_profile.updated" | "delivery_rate.archived" | "delivery_rate.created" | "delivery_rate.updated" | "delivery_revocation.created" | "delivery_selection.committed" | "delivery_zone.archived" | "delivery_zone.created" | "delivery_zone.deactivated" | "delivery_zone.activated" | "delivery_zone.updated" | "invoice.collection_block_resolved" | "invoice.collection_blocked" | "invoice.credited" | "invoice.created" | "invoice.delivery_failed" | "invoice.delivery_succeeded" | "invoice.issued" | "invoice.issue_failed" | "invoice.late_fee_due" | "invoice.late_fee_assessed" | "invoice.late_fee_waived" | "invoice.marked_uncollectible" | "invoice.manual_payment_recorded" | "invoice.manual_payment_reversed" | "invoice.overdue" | "invoice.paid" | "invoice.payment_processing" | "invoice.payment_attempt_canceled" | "invoice.payment_attempt_expired" | "invoice.payment_failed" | "invoice.partially_paid" | "invoice.partially_refunded" | "invoice.refunded" | "invoice.reminder_due" | "invoice.sent" | "invoice.updated" | "invoice.voided" | "inventory.action_required" | "inventory.count.applied" | "inventory.level.updated" | "inventory.receipt.created" | "inventory.reservation.at_risk" | "inventory.reservation.closed" | "inventory.reservation.committed" | "inventory.reservation.consumed" | "inventory.reservation.created" | "inventory.reservation.hold_expired" | "inventory.reservation.released" | "inventory.shortage.detected" | "inventory.transfer.closed" | "inventory.transfer.departed" | "inventory.transfer.lost" | "inventory.transfer.received" | "inventory.transfer.returned" | "merchant_billing_balance.updated" | "merchant.readiness.updated" | "merchant_subscription_invoice.issued" | "merchant_subscription_invoice.updated" | "order.closed" | "order.created" | "order.fulfillment.completed" | "order.fulfillment.created" | "order.fulfillment.event.created" | "order.fulfillment.package.created" | "order.fulfillment.package.updated" | "order.fulfillment.shipment.created" | "order.fulfillment.shipment.updated" | "order.fulfillment.status_changed" | "order.fulfillment.updated" | "order.inventory_action_required" | "order.inventory_exception.created" | "order.inventory_exception.resolved" | "order.payment_authorization_expired" | "order.payment_authorization_canceled" | "order.payment_authorized" | "order.payment_captured" | "order.partially_paid" | "order.paid" | "order.refunded" | "order.updated" | "payment_intent.canceled" | "payment_intent.fulfillment_hold.updated" | "payment_intent.payment_failed" | "payment_intent.processing" | "payment_intent.requires_action" | "payment_intent.requires_capture" | "payment_intent.succeeded" | "payment_method.failed" | "payment_method.removed" | "payment_method.saved" | "payout.canceled" | "payout.created" | "payout.failed" | "payout.paid" | "payout.reversed" | "payout.updated" | "payout_destination.created" | "payout_destination.deleted" | "payout_destination.disabled" | "payout_destination.updated" | "payout_settings.updated" | "refund.created" | "refund.failed" | "refund.updated" | "report.failed" | "report.succeeded" | "return.canceled" | "return.completed" | "return.created" | "return.decision_recorded" | "return.reopened" | "return.updated" | "return_disposition.created" | "return_disposition.updated" | "return_inspection.acceptance_decided" | "return_inspection.created" | "return_inspection.superseded" | "return_receipt.created" | "return_receipt.superseded" | "return_receipt.verified" | "return_resolution.created" | "return_resolution.updated" | "review.closed" | "review.opened" | "subscription.activated" | "subscription.canceled" | "subscription.created" | "subscription.dunning_exhausted" | "subscription.past_due" | "subscription.paused" | "subscription.payment_failed" | "subscription.payment_succeeded" | "subscription.resumed" | "subscription.renewal_upcoming" | "subscription.trial_ending" | "subscription.updated"; [key: string]: unknown; }>) & { "Idempotency-Key"?: InputValue<string>; "Flint-Version"?: InputValue<string> }, options?: RequestOptions<"merchant" | "merchantKey">)`
19164
19336
 
19165
19337
  Path arguments: `path0` = `webhook_endpoint_id`. Params contain flat body fields and query/header fields.
19166
19338
 
19167
- Canonical input schema (for configuration examples and HTTP fixtures): `{ "webhook_endpoint_id": string; "Idempotency-Key"?: string; "Flint-Version"?: string; "body": { "event_type": "balance.updated" | "balance_transaction.created" | "balance_transaction.updated" | "capability.updated" | "checkout_session.completed" | "checkout_session.closed" | "checkout_session.expired" | "checkout_session.invalidated" | "credit_note.allocation_created" | "credit_note.allocation_reversed" | "credit_note.created" | "credit_note.issued" | "credit_note.updated" | "credit_note.voided" | "customer.created" | "customer.deletion_completed" | "customer.deletion_rejected" | "customer.deletion_requested" | "customer.updated" | "dispute.closed" | "dispute.created" | "dispute.lost" | "dispute.needs_response" | "dispute.prevented" | "dispute.updated" | "dispute.warning_closed" | "dispute.won" | "fraud_warning.created" | "fraud_warning.updated" | "delivery_rate_callback.archived" | "delivery_rate_callback.created" | "delivery_rate_callback.deactivated" | "delivery_rate_callback.activated" | "delivery_rate_callback.updated" | "delivery_method.archived" | "delivery_method.created" | "delivery_method.deactivated" | "delivery_method.activated" | "delivery_method.updated" | "delivery_location_set.archived" | "delivery_location_set.created" | "delivery_location_set.deactivated" | "delivery_location_set.activated" | "delivery_location_set.updated" | "delivery_profile.archived" | "delivery_profile.created" | "delivery_profile.deactivated" | "delivery_profile.activated" | "delivery_profile.updated" | "delivery_rate.archived" | "delivery_rate.created" | "delivery_rate.updated" | "delivery_revocation.created" | "delivery_selection.committed" | "delivery_zone.archived" | "delivery_zone.created" | "delivery_zone.deactivated" | "delivery_zone.activated" | "delivery_zone.updated" | "invoice.collection_block_resolved" | "invoice.collection_blocked" | "invoice.credited" | "invoice.created" | "invoice.delivery_failed" | "invoice.delivery_succeeded" | "invoice.issued" | "invoice.issue_failed" | "invoice.late_fee_due" | "invoice.marked_uncollectible" | "invoice.manual_payment_recorded" | "invoice.manual_payment_reversed" | "invoice.overdue" | "invoice.paid" | "invoice.payment_processing" | "invoice.payment_attempt_canceled" | "invoice.payment_attempt_expired" | "invoice.payment_failed" | "invoice.partially_paid" | "invoice.partially_refunded" | "invoice.refunded" | "invoice.reminder_due" | "invoice.sent" | "invoice.updated" | "invoice.voided" | "inventory.action_required" | "inventory.count.applied" | "inventory.level.updated" | "inventory.receipt.created" | "inventory.reservation.at_risk" | "inventory.reservation.closed" | "inventory.reservation.committed" | "inventory.reservation.consumed" | "inventory.reservation.created" | "inventory.reservation.hold_expired" | "inventory.reservation.released" | "inventory.shortage.detected" | "inventory.transfer.closed" | "inventory.transfer.departed" | "inventory.transfer.lost" | "inventory.transfer.received" | "inventory.transfer.returned" | "merchant_billing_balance.updated" | "merchant.readiness.updated" | "merchant_subscription_invoice.issued" | "merchant_subscription_invoice.updated" | "order.closed" | "order.created" | "order.fulfillment.completed" | "order.fulfillment.created" | "order.fulfillment.event.created" | "order.fulfillment.package.created" | "order.fulfillment.package.updated" | "order.fulfillment.shipment.created" | "order.fulfillment.shipment.updated" | "order.fulfillment.status_changed" | "order.fulfillment.updated" | "order.inventory_action_required" | "order.inventory_exception.created" | "order.inventory_exception.resolved" | "order.payment_authorization_expired" | "order.payment_authorization_canceled" | "order.payment_authorized" | "order.payment_captured" | "order.partially_paid" | "order.paid" | "order.refunded" | "order.updated" | "payment_intent.canceled" | "payment_intent.fulfillment_hold.updated" | "payment_intent.payment_failed" | "payment_intent.processing" | "payment_intent.requires_action" | "payment_intent.requires_capture" | "payment_intent.succeeded" | "payment_method.failed" | "payment_method.removed" | "payment_method.saved" | "payout.canceled" | "payout.created" | "payout.failed" | "payout.paid" | "payout.reversed" | "payout.updated" | "payout_destination.created" | "payout_destination.deleted" | "payout_destination.disabled" | "payout_destination.updated" | "payout_settings.updated" | "refund.created" | "refund.failed" | "refund.updated" | "report.failed" | "report.succeeded" | "return.canceled" | "return.completed" | "return.created" | "return.decision_recorded" | "return.reopened" | "return.updated" | "return_disposition.created" | "return_disposition.updated" | "return_inspection.acceptance_decided" | "return_inspection.created" | "return_inspection.superseded" | "return_receipt.created" | "return_receipt.superseded" | "return_receipt.verified" | "return_resolution.created" | "return_resolution.updated" | "review.closed" | "review.opened" | "subscription.activated" | "subscription.canceled" | "subscription.created" | "subscription.dunning_exhausted" | "subscription.past_due" | "subscription.paused" | "subscription.payment_failed" | "subscription.payment_succeeded" | "subscription.resumed" | "subscription.renewal_upcoming" | "subscription.trial_ending" | "subscription.updated"; [key: string]: unknown; }; }`
19339
+ Canonical input schema (for configuration examples and HTTP fixtures): `{ "webhook_endpoint_id": string; "Idempotency-Key"?: string; "Flint-Version"?: string; "body": { "event_type": "balance.updated" | "balance_transaction.created" | "balance_transaction.updated" | "capability.updated" | "checkout_session.completed" | "checkout_session.closed" | "checkout_session.expired" | "checkout_session.invalidated" | "credit_note.allocation_created" | "credit_note.allocation_reversed" | "credit_note.created" | "credit_note.issued" | "credit_note.updated" | "credit_note.voided" | "customer.created" | "customer.deletion_completed" | "customer.deletion_rejected" | "customer.deletion_requested" | "customer.updated" | "dispute.closed" | "dispute.created" | "dispute.lost" | "dispute.needs_response" | "dispute.prevented" | "dispute.updated" | "dispute.warning_closed" | "dispute.won" | "fraud_warning.created" | "fraud_warning.updated" | "delivery_rate_callback.archived" | "delivery_rate_callback.created" | "delivery_rate_callback.deactivated" | "delivery_rate_callback.activated" | "delivery_rate_callback.updated" | "delivery_method.archived" | "delivery_method.created" | "delivery_method.deactivated" | "delivery_method.activated" | "delivery_method.updated" | "delivery_location_set.archived" | "delivery_location_set.created" | "delivery_location_set.deactivated" | "delivery_location_set.activated" | "delivery_location_set.updated" | "delivery_profile.archived" | "delivery_profile.created" | "delivery_profile.deactivated" | "delivery_profile.activated" | "delivery_profile.updated" | "delivery_rate.archived" | "delivery_rate.created" | "delivery_rate.updated" | "delivery_revocation.created" | "delivery_selection.committed" | "delivery_zone.archived" | "delivery_zone.created" | "delivery_zone.deactivated" | "delivery_zone.activated" | "delivery_zone.updated" | "invoice.collection_block_resolved" | "invoice.collection_blocked" | "invoice.credited" | "invoice.created" | "invoice.delivery_failed" | "invoice.delivery_succeeded" | "invoice.issued" | "invoice.issue_failed" | "invoice.late_fee_due" | "invoice.late_fee_assessed" | "invoice.late_fee_waived" | "invoice.marked_uncollectible" | "invoice.manual_payment_recorded" | "invoice.manual_payment_reversed" | "invoice.overdue" | "invoice.paid" | "invoice.payment_processing" | "invoice.payment_attempt_canceled" | "invoice.payment_attempt_expired" | "invoice.payment_failed" | "invoice.partially_paid" | "invoice.partially_refunded" | "invoice.refunded" | "invoice.reminder_due" | "invoice.sent" | "invoice.updated" | "invoice.voided" | "inventory.action_required" | "inventory.count.applied" | "inventory.level.updated" | "inventory.receipt.created" | "inventory.reservation.at_risk" | "inventory.reservation.closed" | "inventory.reservation.committed" | "inventory.reservation.consumed" | "inventory.reservation.created" | "inventory.reservation.hold_expired" | "inventory.reservation.released" | "inventory.shortage.detected" | "inventory.transfer.closed" | "inventory.transfer.departed" | "inventory.transfer.lost" | "inventory.transfer.received" | "inventory.transfer.returned" | "merchant_billing_balance.updated" | "merchant.readiness.updated" | "merchant_subscription_invoice.issued" | "merchant_subscription_invoice.updated" | "order.closed" | "order.created" | "order.fulfillment.completed" | "order.fulfillment.created" | "order.fulfillment.event.created" | "order.fulfillment.package.created" | "order.fulfillment.package.updated" | "order.fulfillment.shipment.created" | "order.fulfillment.shipment.updated" | "order.fulfillment.status_changed" | "order.fulfillment.updated" | "order.inventory_action_required" | "order.inventory_exception.created" | "order.inventory_exception.resolved" | "order.payment_authorization_expired" | "order.payment_authorization_canceled" | "order.payment_authorized" | "order.payment_captured" | "order.partially_paid" | "order.paid" | "order.refunded" | "order.updated" | "payment_intent.canceled" | "payment_intent.fulfillment_hold.updated" | "payment_intent.payment_failed" | "payment_intent.processing" | "payment_intent.requires_action" | "payment_intent.requires_capture" | "payment_intent.succeeded" | "payment_method.failed" | "payment_method.removed" | "payment_method.saved" | "payout.canceled" | "payout.created" | "payout.failed" | "payout.paid" | "payout.reversed" | "payout.updated" | "payout_destination.created" | "payout_destination.deleted" | "payout_destination.disabled" | "payout_destination.updated" | "payout_settings.updated" | "refund.created" | "refund.failed" | "refund.updated" | "report.failed" | "report.succeeded" | "return.canceled" | "return.completed" | "return.created" | "return.decision_recorded" | "return.reopened" | "return.updated" | "return_disposition.created" | "return_disposition.updated" | "return_inspection.acceptance_decided" | "return_inspection.created" | "return_inspection.superseded" | "return_receipt.created" | "return_receipt.superseded" | "return_receipt.verified" | "return_resolution.created" | "return_resolution.updated" | "review.closed" | "review.opened" | "subscription.activated" | "subscription.canceled" | "subscription.created" | "subscription.dunning_exhausted" | "subscription.past_due" | "subscription.paused" | "subscription.payment_failed" | "subscription.payment_succeeded" | "subscription.resumed" | "subscription.renewal_upcoming" | "subscription.trial_ending" | "subscription.updated"; [key: string]: unknown; }; }`
19168
19340
 
19169
19341
  Returned payload: `WebhookDeliveryAction`
19170
19342
 
@@ -19408,11 +19580,11 @@ Returns recent canonical webhook events for the authenticated merchant.
19408
19580
 
19409
19581
  `GET /v1/webhook-events`
19410
19582
 
19411
- Call: `list(params?: { "page_size"?: InputValue<number>; "page_token"?: InputValue<string>; "webhook_endpoint_id"?: InputValue<string>; "delivery_status"?: InputValue<"pending" | "delivered" | "failed" | "suppressed">; "event_source"?: InputValue<Array<"merchant" | "partner_app" | "installed_merchants">>; "partner_app_id"?: InputValue<string>; "event_type"?: InputValue<"balance.updated" | "balance_transaction.created" | "balance_transaction.updated" | "capability.updated" | "checkout_session.closed" | "checkout_session.completed" | "checkout_session.expired" | "checkout_session.invalidated" | "credit_note.allocation_created" | "credit_note.allocation_reversed" | "credit_note.created" | "credit_note.issued" | "credit_note.updated" | "credit_note.voided" | "customer.created" | "customer.deletion_completed" | "customer.deletion_rejected" | "customer.deletion_requested" | "customer.updated" | "delivery_location_set.activated" | "delivery_location_set.archived" | "delivery_location_set.created" | "delivery_location_set.deactivated" | "delivery_location_set.updated" | "delivery_method.activated" | "delivery_method.archived" | "delivery_method.created" | "delivery_method.deactivated" | "delivery_method.updated" | "delivery_profile.activated" | "delivery_profile.archived" | "delivery_profile.created" | "delivery_profile.deactivated" | "delivery_profile.updated" | "delivery_rate.archived" | "delivery_rate.created" | "delivery_rate.updated" | "delivery_rate_callback.activated" | "delivery_rate_callback.archived" | "delivery_rate_callback.created" | "delivery_rate_callback.deactivated" | "delivery_rate_callback.updated" | "delivery_revocation.created" | "delivery_selection.committed" | "delivery_zone.activated" | "delivery_zone.archived" | "delivery_zone.created" | "delivery_zone.deactivated" | "delivery_zone.updated" | "dispute.closed" | "dispute.created" | "dispute.lost" | "dispute.needs_response" | "dispute.prevented" | "dispute.updated" | "dispute.warning_closed" | "dispute.won" | "fraud_warning.created" | "fraud_warning.updated" | "inventory.action_required" | "inventory.count.applied" | "inventory.level.updated" | "inventory.receipt.created" | "inventory.reservation.at_risk" | "inventory.reservation.closed" | "inventory.reservation.committed" | "inventory.reservation.consumed" | "inventory.reservation.created" | "inventory.reservation.hold_expired" | "inventory.reservation.released" | "inventory.shortage.detected" | "inventory.transfer.closed" | "inventory.transfer.departed" | "inventory.transfer.lost" | "inventory.transfer.received" | "inventory.transfer.returned" | "invoice.collection_block_resolved" | "invoice.collection_blocked" | "invoice.created" | "invoice.credited" | "invoice.delivery_failed" | "invoice.delivery_succeeded" | "invoice.issue_failed" | "invoice.issued" | "invoice.late_fee_due" | "invoice.manual_payment_recorded" | "invoice.manual_payment_reversed" | "invoice.marked_uncollectible" | "invoice.overdue" | "invoice.paid" | "invoice.partially_paid" | "invoice.partially_refunded" | "invoice.payment_attempt_canceled" | "invoice.payment_attempt_expired" | "invoice.payment_failed" | "invoice.payment_processing" | "invoice.refunded" | "invoice.reminder_due" | "invoice.sent" | "invoice.updated" | "invoice.voided" | "merchant.readiness.updated" | "merchant_billing_balance.updated" | "merchant_subscription_invoice.issued" | "merchant_subscription_invoice.updated" | "order.closed" | "order.created" | "order.fulfillment.completed" | "order.fulfillment.created" | "order.fulfillment.event.created" | "order.fulfillment.package.created" | "order.fulfillment.package.updated" | "order.fulfillment.shipment.created" | "order.fulfillment.shipment.updated" | "order.fulfillment.status_changed" | "order.fulfillment.updated" | "order.inventory_action_required" | "order.inventory_exception.created" | "order.inventory_exception.resolved" | "order.paid" | "order.partially_paid" | "order.payment_authorization_canceled" | "order.payment_authorization_expired" | "order.payment_authorized" | "order.payment_captured" | "order.refunded" | "order.updated" | "partner_app.install.created" | "partner_app.install.environment_grant.created" | "partner_app.install.environment_grant.revoked" | "partner_app.install.permissions_updated" | "partner_app.install.revoked" | "partner_app.install.updated" | "payment_intent.canceled" | "payment_intent.fulfillment_hold.updated" | "payment_intent.payment_failed" | "payment_intent.processing" | "payment_intent.requires_action" | "payment_intent.requires_capture" | "payment_intent.succeeded" | "payment_method.failed" | "payment_method.removed" | "payment_method.saved" | "payout.canceled" | "payout.created" | "payout.failed" | "payout.paid" | "payout.reversed" | "payout.updated" | "payout_destination.created" | "payout_destination.deleted" | "payout_destination.disabled" | "payout_destination.updated" | "payout_settings.updated" | "refund.created" | "refund.failed" | "refund.updated" | "report.failed" | "report.succeeded" | "return.canceled" | "return.completed" | "return.created" | "return.decision_recorded" | "return.reopened" | "return.updated" | "return_disposition.created" | "return_disposition.updated" | "return_inspection.acceptance_decided" | "return_inspection.created" | "return_inspection.superseded" | "return_receipt.created" | "return_receipt.superseded" | "return_receipt.verified" | "return_resolution.created" | "return_resolution.updated" | "review.closed" | "review.opened" | "subscription.activated" | "subscription.canceled" | "subscription.created" | "subscription.dunning_exhausted" | "subscription.past_due" | "subscription.paused" | "subscription.payment_failed" | "subscription.payment_succeeded" | "subscription.renewal_upcoming" | "subscription.resumed" | "subscription.trial_ending" | "subscription.updated">; "resource_type"?: InputValue<"balance" | "balance_transaction" | "capability" | "checkout_session" | "customer" | "dispute" | "fraud_warning" | "invoice" | "merchant" | "inventory_count" | "inventory_level" | "inventory_reservation" | "inventory_reservation_line" | "inventory_receipt" | "inventory_transfer" | "order" | "payment_intent" | "payment_method" | "payout" | "payout_destination" | "payout_settings" | "refund" | "return" | "return_disposition" | "return_inspection" | "return_receipt" | "return_resolution" | "review" | "subscription">; "resource_id"?: InputValue<string>; "api_request_log_id"?: InputValue<string>; "request_id"?: InputValue<string>; "correlation_id"?: InputValue<string>; "created_after"?: InputValue<string>; "created_before"?: InputValue<string>; "include"?: InputValue<Array<"test_events">>; "Flint-Version"?: InputValue<string> }, options?: RequestOptions<"merchant" | "merchantKey">)`
19583
+ Call: `list(params?: { "page_size"?: InputValue<number>; "page_token"?: InputValue<string>; "webhook_endpoint_id"?: InputValue<string>; "delivery_status"?: InputValue<"pending" | "delivered" | "failed" | "suppressed">; "event_source"?: InputValue<Array<"merchant" | "partner_app" | "installed_merchants">>; "partner_app_id"?: InputValue<string>; "event_type"?: InputValue<"balance.updated" | "balance_transaction.created" | "balance_transaction.updated" | "capability.updated" | "checkout_session.closed" | "checkout_session.completed" | "checkout_session.expired" | "checkout_session.invalidated" | "credit_note.allocation_created" | "credit_note.allocation_reversed" | "credit_note.created" | "credit_note.issued" | "credit_note.updated" | "credit_note.voided" | "customer.created" | "customer.deletion_completed" | "customer.deletion_rejected" | "customer.deletion_requested" | "customer.updated" | "delivery_location_set.activated" | "delivery_location_set.archived" | "delivery_location_set.created" | "delivery_location_set.deactivated" | "delivery_location_set.updated" | "delivery_method.activated" | "delivery_method.archived" | "delivery_method.created" | "delivery_method.deactivated" | "delivery_method.updated" | "delivery_profile.activated" | "delivery_profile.archived" | "delivery_profile.created" | "delivery_profile.deactivated" | "delivery_profile.updated" | "delivery_rate.archived" | "delivery_rate.created" | "delivery_rate.updated" | "delivery_rate_callback.activated" | "delivery_rate_callback.archived" | "delivery_rate_callback.created" | "delivery_rate_callback.deactivated" | "delivery_rate_callback.updated" | "delivery_revocation.created" | "delivery_selection.committed" | "delivery_zone.activated" | "delivery_zone.archived" | "delivery_zone.created" | "delivery_zone.deactivated" | "delivery_zone.updated" | "dispute.closed" | "dispute.created" | "dispute.lost" | "dispute.needs_response" | "dispute.prevented" | "dispute.updated" | "dispute.warning_closed" | "dispute.won" | "fraud_warning.created" | "fraud_warning.updated" | "inventory.action_required" | "inventory.count.applied" | "inventory.level.updated" | "inventory.receipt.created" | "inventory.reservation.at_risk" | "inventory.reservation.closed" | "inventory.reservation.committed" | "inventory.reservation.consumed" | "inventory.reservation.created" | "inventory.reservation.hold_expired" | "inventory.reservation.released" | "inventory.shortage.detected" | "inventory.transfer.closed" | "inventory.transfer.departed" | "inventory.transfer.lost" | "inventory.transfer.received" | "inventory.transfer.returned" | "invoice.collection_block_resolved" | "invoice.collection_blocked" | "invoice.created" | "invoice.credited" | "invoice.delivery_failed" | "invoice.delivery_succeeded" | "invoice.issue_failed" | "invoice.issued" | "invoice.late_fee_assessed" | "invoice.late_fee_due" | "invoice.late_fee_waived" | "invoice.manual_payment_recorded" | "invoice.manual_payment_reversed" | "invoice.marked_uncollectible" | "invoice.overdue" | "invoice.paid" | "invoice.partially_paid" | "invoice.partially_refunded" | "invoice.payment_attempt_canceled" | "invoice.payment_attempt_expired" | "invoice.payment_failed" | "invoice.payment_processing" | "invoice.refunded" | "invoice.reminder_due" | "invoice.sent" | "invoice.updated" | "invoice.voided" | "merchant.readiness.updated" | "merchant_billing_balance.updated" | "merchant_subscription_invoice.issued" | "merchant_subscription_invoice.updated" | "order.closed" | "order.created" | "order.fulfillment.completed" | "order.fulfillment.created" | "order.fulfillment.event.created" | "order.fulfillment.package.created" | "order.fulfillment.package.updated" | "order.fulfillment.shipment.created" | "order.fulfillment.shipment.updated" | "order.fulfillment.status_changed" | "order.fulfillment.updated" | "order.inventory_action_required" | "order.inventory_exception.created" | "order.inventory_exception.resolved" | "order.paid" | "order.partially_paid" | "order.payment_authorization_canceled" | "order.payment_authorization_expired" | "order.payment_authorized" | "order.payment_captured" | "order.refunded" | "order.updated" | "partner_app.install.created" | "partner_app.install.environment_grant.created" | "partner_app.install.environment_grant.revoked" | "partner_app.install.permissions_updated" | "partner_app.install.revoked" | "partner_app.install.updated" | "payment_intent.canceled" | "payment_intent.fulfillment_hold.updated" | "payment_intent.payment_failed" | "payment_intent.processing" | "payment_intent.requires_action" | "payment_intent.requires_capture" | "payment_intent.succeeded" | "payment_method.failed" | "payment_method.removed" | "payment_method.saved" | "payout.canceled" | "payout.created" | "payout.failed" | "payout.paid" | "payout.reversed" | "payout.updated" | "payout_destination.created" | "payout_destination.deleted" | "payout_destination.disabled" | "payout_destination.updated" | "payout_settings.updated" | "refund.created" | "refund.failed" | "refund.updated" | "report.failed" | "report.succeeded" | "return.canceled" | "return.completed" | "return.created" | "return.decision_recorded" | "return.reopened" | "return.updated" | "return_disposition.created" | "return_disposition.updated" | "return_inspection.acceptance_decided" | "return_inspection.created" | "return_inspection.superseded" | "return_receipt.created" | "return_receipt.superseded" | "return_receipt.verified" | "return_resolution.created" | "return_resolution.updated" | "review.closed" | "review.opened" | "subscription.activated" | "subscription.canceled" | "subscription.created" | "subscription.dunning_exhausted" | "subscription.past_due" | "subscription.paused" | "subscription.payment_failed" | "subscription.payment_succeeded" | "subscription.renewal_upcoming" | "subscription.resumed" | "subscription.trial_ending" | "subscription.updated">; "resource_type"?: InputValue<"balance" | "balance_transaction" | "capability" | "checkout_session" | "customer" | "dispute" | "fraud_warning" | "invoice" | "merchant" | "inventory_count" | "inventory_level" | "inventory_reservation" | "inventory_reservation_line" | "inventory_receipt" | "inventory_transfer" | "order" | "payment_intent" | "payment_method" | "payout" | "payout_destination" | "payout_settings" | "refund" | "return" | "return_disposition" | "return_inspection" | "return_receipt" | "return_resolution" | "review" | "subscription">; "resource_id"?: InputValue<string>; "api_request_log_id"?: InputValue<string>; "request_id"?: InputValue<string>; "correlation_id"?: InputValue<string>; "created_after"?: InputValue<string>; "created_before"?: InputValue<string>; "include"?: InputValue<Array<"test_events">>; "Flint-Version"?: InputValue<string> }, options?: RequestOptions<"merchant" | "merchantKey">)`
19412
19584
 
19413
19585
  Path arguments: none. Params contain flat body fields and query/header fields.
19414
19586
 
19415
- Canonical input schema (for configuration examples and HTTP fixtures): `{ "page_size"?: number; "page_token"?: string; "webhook_endpoint_id"?: string; "delivery_status"?: "pending" | "delivered" | "failed" | "suppressed"; "event_source"?: Array<"merchant" | "partner_app" | "installed_merchants">; "partner_app_id"?: string; "event_type"?: "balance.updated" | "balance_transaction.created" | "balance_transaction.updated" | "capability.updated" | "checkout_session.closed" | "checkout_session.completed" | "checkout_session.expired" | "checkout_session.invalidated" | "credit_note.allocation_created" | "credit_note.allocation_reversed" | "credit_note.created" | "credit_note.issued" | "credit_note.updated" | "credit_note.voided" | "customer.created" | "customer.deletion_completed" | "customer.deletion_rejected" | "customer.deletion_requested" | "customer.updated" | "delivery_location_set.activated" | "delivery_location_set.archived" | "delivery_location_set.created" | "delivery_location_set.deactivated" | "delivery_location_set.updated" | "delivery_method.activated" | "delivery_method.archived" | "delivery_method.created" | "delivery_method.deactivated" | "delivery_method.updated" | "delivery_profile.activated" | "delivery_profile.archived" | "delivery_profile.created" | "delivery_profile.deactivated" | "delivery_profile.updated" | "delivery_rate.archived" | "delivery_rate.created" | "delivery_rate.updated" | "delivery_rate_callback.activated" | "delivery_rate_callback.archived" | "delivery_rate_callback.created" | "delivery_rate_callback.deactivated" | "delivery_rate_callback.updated" | "delivery_revocation.created" | "delivery_selection.committed" | "delivery_zone.activated" | "delivery_zone.archived" | "delivery_zone.created" | "delivery_zone.deactivated" | "delivery_zone.updated" | "dispute.closed" | "dispute.created" | "dispute.lost" | "dispute.needs_response" | "dispute.prevented" | "dispute.updated" | "dispute.warning_closed" | "dispute.won" | "fraud_warning.created" | "fraud_warning.updated" | "inventory.action_required" | "inventory.count.applied" | "inventory.level.updated" | "inventory.receipt.created" | "inventory.reservation.at_risk" | "inventory.reservation.closed" | "inventory.reservation.committed" | "inventory.reservation.consumed" | "inventory.reservation.created" | "inventory.reservation.hold_expired" | "inventory.reservation.released" | "inventory.shortage.detected" | "inventory.transfer.closed" | "inventory.transfer.departed" | "inventory.transfer.lost" | "inventory.transfer.received" | "inventory.transfer.returned" | "invoice.collection_block_resolved" | "invoice.collection_blocked" | "invoice.created" | "invoice.credited" | "invoice.delivery_failed" | "invoice.delivery_succeeded" | "invoice.issue_failed" | "invoice.issued" | "invoice.late_fee_due" | "invoice.manual_payment_recorded" | "invoice.manual_payment_reversed" | "invoice.marked_uncollectible" | "invoice.overdue" | "invoice.paid" | "invoice.partially_paid" | "invoice.partially_refunded" | "invoice.payment_attempt_canceled" | "invoice.payment_attempt_expired" | "invoice.payment_failed" | "invoice.payment_processing" | "invoice.refunded" | "invoice.reminder_due" | "invoice.sent" | "invoice.updated" | "invoice.voided" | "merchant.readiness.updated" | "merchant_billing_balance.updated" | "merchant_subscription_invoice.issued" | "merchant_subscription_invoice.updated" | "order.closed" | "order.created" | "order.fulfillment.completed" | "order.fulfillment.created" | "order.fulfillment.event.created" | "order.fulfillment.package.created" | "order.fulfillment.package.updated" | "order.fulfillment.shipment.created" | "order.fulfillment.shipment.updated" | "order.fulfillment.status_changed" | "order.fulfillment.updated" | "order.inventory_action_required" | "order.inventory_exception.created" | "order.inventory_exception.resolved" | "order.paid" | "order.partially_paid" | "order.payment_authorization_canceled" | "order.payment_authorization_expired" | "order.payment_authorized" | "order.payment_captured" | "order.refunded" | "order.updated" | "partner_app.install.created" | "partner_app.install.environment_grant.created" | "partner_app.install.environment_grant.revoked" | "partner_app.install.permissions_updated" | "partner_app.install.revoked" | "partner_app.install.updated" | "payment_intent.canceled" | "payment_intent.fulfillment_hold.updated" | "payment_intent.payment_failed" | "payment_intent.processing" | "payment_intent.requires_action" | "payment_intent.requires_capture" | "payment_intent.succeeded" | "payment_method.failed" | "payment_method.removed" | "payment_method.saved" | "payout.canceled" | "payout.created" | "payout.failed" | "payout.paid" | "payout.reversed" | "payout.updated" | "payout_destination.created" | "payout_destination.deleted" | "payout_destination.disabled" | "payout_destination.updated" | "payout_settings.updated" | "refund.created" | "refund.failed" | "refund.updated" | "report.failed" | "report.succeeded" | "return.canceled" | "return.completed" | "return.created" | "return.decision_recorded" | "return.reopened" | "return.updated" | "return_disposition.created" | "return_disposition.updated" | "return_inspection.acceptance_decided" | "return_inspection.created" | "return_inspection.superseded" | "return_receipt.created" | "return_receipt.superseded" | "return_receipt.verified" | "return_resolution.created" | "return_resolution.updated" | "review.closed" | "review.opened" | "subscription.activated" | "subscription.canceled" | "subscription.created" | "subscription.dunning_exhausted" | "subscription.past_due" | "subscription.paused" | "subscription.payment_failed" | "subscription.payment_succeeded" | "subscription.renewal_upcoming" | "subscription.resumed" | "subscription.trial_ending" | "subscription.updated"; "resource_type"?: "balance" | "balance_transaction" | "capability" | "checkout_session" | "customer" | "dispute" | "fraud_warning" | "invoice" | "merchant" | "inventory_count" | "inventory_level" | "inventory_reservation" | "inventory_reservation_line" | "inventory_receipt" | "inventory_transfer" | "order" | "payment_intent" | "payment_method" | "payout" | "payout_destination" | "payout_settings" | "refund" | "return" | "return_disposition" | "return_inspection" | "return_receipt" | "return_resolution" | "review" | "subscription"; "resource_id"?: string; "api_request_log_id"?: string; "request_id"?: string; "correlation_id"?: string; "created_after"?: string; "created_before"?: string; "include"?: Array<"test_events">; "Flint-Version"?: string; }`
19587
+ Canonical input schema (for configuration examples and HTTP fixtures): `{ "page_size"?: number; "page_token"?: string; "webhook_endpoint_id"?: string; "delivery_status"?: "pending" | "delivered" | "failed" | "suppressed"; "event_source"?: Array<"merchant" | "partner_app" | "installed_merchants">; "partner_app_id"?: string; "event_type"?: "balance.updated" | "balance_transaction.created" | "balance_transaction.updated" | "capability.updated" | "checkout_session.closed" | "checkout_session.completed" | "checkout_session.expired" | "checkout_session.invalidated" | "credit_note.allocation_created" | "credit_note.allocation_reversed" | "credit_note.created" | "credit_note.issued" | "credit_note.updated" | "credit_note.voided" | "customer.created" | "customer.deletion_completed" | "customer.deletion_rejected" | "customer.deletion_requested" | "customer.updated" | "delivery_location_set.activated" | "delivery_location_set.archived" | "delivery_location_set.created" | "delivery_location_set.deactivated" | "delivery_location_set.updated" | "delivery_method.activated" | "delivery_method.archived" | "delivery_method.created" | "delivery_method.deactivated" | "delivery_method.updated" | "delivery_profile.activated" | "delivery_profile.archived" | "delivery_profile.created" | "delivery_profile.deactivated" | "delivery_profile.updated" | "delivery_rate.archived" | "delivery_rate.created" | "delivery_rate.updated" | "delivery_rate_callback.activated" | "delivery_rate_callback.archived" | "delivery_rate_callback.created" | "delivery_rate_callback.deactivated" | "delivery_rate_callback.updated" | "delivery_revocation.created" | "delivery_selection.committed" | "delivery_zone.activated" | "delivery_zone.archived" | "delivery_zone.created" | "delivery_zone.deactivated" | "delivery_zone.updated" | "dispute.closed" | "dispute.created" | "dispute.lost" | "dispute.needs_response" | "dispute.prevented" | "dispute.updated" | "dispute.warning_closed" | "dispute.won" | "fraud_warning.created" | "fraud_warning.updated" | "inventory.action_required" | "inventory.count.applied" | "inventory.level.updated" | "inventory.receipt.created" | "inventory.reservation.at_risk" | "inventory.reservation.closed" | "inventory.reservation.committed" | "inventory.reservation.consumed" | "inventory.reservation.created" | "inventory.reservation.hold_expired" | "inventory.reservation.released" | "inventory.shortage.detected" | "inventory.transfer.closed" | "inventory.transfer.departed" | "inventory.transfer.lost" | "inventory.transfer.received" | "inventory.transfer.returned" | "invoice.collection_block_resolved" | "invoice.collection_blocked" | "invoice.created" | "invoice.credited" | "invoice.delivery_failed" | "invoice.delivery_succeeded" | "invoice.issue_failed" | "invoice.issued" | "invoice.late_fee_assessed" | "invoice.late_fee_due" | "invoice.late_fee_waived" | "invoice.manual_payment_recorded" | "invoice.manual_payment_reversed" | "invoice.marked_uncollectible" | "invoice.overdue" | "invoice.paid" | "invoice.partially_paid" | "invoice.partially_refunded" | "invoice.payment_attempt_canceled" | "invoice.payment_attempt_expired" | "invoice.payment_failed" | "invoice.payment_processing" | "invoice.refunded" | "invoice.reminder_due" | "invoice.sent" | "invoice.updated" | "invoice.voided" | "merchant.readiness.updated" | "merchant_billing_balance.updated" | "merchant_subscription_invoice.issued" | "merchant_subscription_invoice.updated" | "order.closed" | "order.created" | "order.fulfillment.completed" | "order.fulfillment.created" | "order.fulfillment.event.created" | "order.fulfillment.package.created" | "order.fulfillment.package.updated" | "order.fulfillment.shipment.created" | "order.fulfillment.shipment.updated" | "order.fulfillment.status_changed" | "order.fulfillment.updated" | "order.inventory_action_required" | "order.inventory_exception.created" | "order.inventory_exception.resolved" | "order.paid" | "order.partially_paid" | "order.payment_authorization_canceled" | "order.payment_authorization_expired" | "order.payment_authorized" | "order.payment_captured" | "order.refunded" | "order.updated" | "partner_app.install.created" | "partner_app.install.environment_grant.created" | "partner_app.install.environment_grant.revoked" | "partner_app.install.permissions_updated" | "partner_app.install.revoked" | "partner_app.install.updated" | "payment_intent.canceled" | "payment_intent.fulfillment_hold.updated" | "payment_intent.payment_failed" | "payment_intent.processing" | "payment_intent.requires_action" | "payment_intent.requires_capture" | "payment_intent.succeeded" | "payment_method.failed" | "payment_method.removed" | "payment_method.saved" | "payout.canceled" | "payout.created" | "payout.failed" | "payout.paid" | "payout.reversed" | "payout.updated" | "payout_destination.created" | "payout_destination.deleted" | "payout_destination.disabled" | "payout_destination.updated" | "payout_settings.updated" | "refund.created" | "refund.failed" | "refund.updated" | "report.failed" | "report.succeeded" | "return.canceled" | "return.completed" | "return.created" | "return.decision_recorded" | "return.reopened" | "return.updated" | "return_disposition.created" | "return_disposition.updated" | "return_inspection.acceptance_decided" | "return_inspection.created" | "return_inspection.superseded" | "return_receipt.created" | "return_receipt.superseded" | "return_receipt.verified" | "return_resolution.created" | "return_resolution.updated" | "review.closed" | "review.opened" | "subscription.activated" | "subscription.canceled" | "subscription.created" | "subscription.dunning_exhausted" | "subscription.past_due" | "subscription.paused" | "subscription.payment_failed" | "subscription.payment_succeeded" | "subscription.renewal_upcoming" | "subscription.resumed" | "subscription.trial_ending" | "subscription.updated"; "resource_type"?: "balance" | "balance_transaction" | "capability" | "checkout_session" | "customer" | "dispute" | "fraud_warning" | "invoice" | "merchant" | "inventory_count" | "inventory_level" | "inventory_reservation" | "inventory_reservation_line" | "inventory_receipt" | "inventory_transfer" | "order" | "payment_intent" | "payment_method" | "payout" | "payout_destination" | "payout_settings" | "refund" | "return" | "return_disposition" | "return_inspection" | "return_receipt" | "return_resolution" | "review" | "subscription"; "resource_id"?: string; "api_request_log_id"?: string; "request_id"?: string; "correlation_id"?: string; "created_after"?: string; "created_before"?: string; "include"?: Array<"test_events">; "Flint-Version"?: string; }`
19416
19588
 
19417
19589
  Returned payload: `Array<WebhookEvent>`
19418
19590
 
@@ -19424,7 +19596,7 @@ Returned payload: `Array<WebhookEvent>`
19424
19596
  | `delivery_status` | Optional | string | Values: "pending", "delivered", "failed", "suppressed". |
19425
19597
  | `event_source` | Optional | Array of string | |
19426
19598
  | `partner_app_id` | Optional | string | |
19427
- | `event_type` | Optional | string | Values: "balance.updated", "balance_transaction.created", "balance_transaction.updated", "capability.updated", "checkout_session.closed", "checkout_session.completed", "checkout_session.expired", "checkout_session.invalidated", "credit_note.allocation_created", "credit_note.allocation_reversed", "credit_note.created", "credit_note.issued", "credit_note.updated", "credit_note.voided", "customer.created", "customer.deletion_completed", "customer.deletion_rejected", "customer.deletion_requested", "customer.updated", "delivery_location_set.activated", "delivery_location_set.archived", "delivery_location_set.created", "delivery_location_set.deactivated", "delivery_location_set.updated", "delivery_method.activated", "delivery_method.archived", "delivery_method.created", "delivery_method.deactivated", "delivery_method.updated", "delivery_profile.activated", "delivery_profile.archived", "delivery_profile.created", "delivery_profile.deactivated", "delivery_profile.updated", "delivery_rate.archived", "delivery_rate.created", "delivery_rate.updated", "delivery_rate_callback.activated", "delivery_rate_callback.archived", "delivery_rate_callback.created", "delivery_rate_callback.deactivated", "delivery_rate_callback.updated", "delivery_revocation.created", "delivery_selection.committed", "delivery_zone.activated", "delivery_zone.archived", "delivery_zone.created", "delivery_zone.deactivated", "delivery_zone.updated", "dispute.closed", "dispute.created", "dispute.lost", "dispute.needs_response", "dispute.prevented", "dispute.updated", "dispute.warning_closed", "dispute.won", "fraud_warning.created", "fraud_warning.updated", "inventory.action_required", "inventory.count.applied", "inventory.level.updated", "inventory.receipt.created", "inventory.reservation.at_risk", "inventory.reservation.closed", "inventory.reservation.committed", "inventory.reservation.consumed", "inventory.reservation.created", "inventory.reservation.hold_expired", "inventory.reservation.released", "inventory.shortage.detected", "inventory.transfer.closed", "inventory.transfer.departed", "inventory.transfer.lost", "inventory.transfer.received", "inventory.transfer.returned", "invoice.collection_block_resolved", "invoice.collection_blocked", "invoice.created", "invoice.credited", "invoice.delivery_failed", "invoice.delivery_succeeded", "invoice.issue_failed", "invoice.issued", "invoice.late_fee_due", "invoice.manual_payment_recorded", "invoice.manual_payment_reversed", "invoice.marked_uncollectible", "invoice.overdue", "invoice.paid", "invoice.partially_paid", "invoice.partially_refunded", "invoice.payment_attempt_canceled", "invoice.payment_attempt_expired", "invoice.payment_failed", "invoice.payment_processing", "invoice.refunded", "invoice.reminder_due", "invoice.sent", "invoice.updated", "invoice.voided", "merchant.readiness.updated", "merchant_billing_balance.updated", "merchant_subscription_invoice.issued", "merchant_subscription_invoice.updated", "order.closed", "order.created", "order.fulfillment.completed", "order.fulfillment.created", "order.fulfillment.event.created", "order.fulfillment.package.created", "order.fulfillment.package.updated", "order.fulfillment.shipment.created", "order.fulfillment.shipment.updated", "order.fulfillment.status_changed", "order.fulfillment.updated", "order.inventory_action_required", "order.inventory_exception.created", "order.inventory_exception.resolved", "order.paid", "order.partially_paid", "order.payment_authorization_canceled", "order.payment_authorization_expired", "order.payment_authorized", "order.payment_captured", "order.refunded", "order.updated", "partner_app.install.created", "partner_app.install.environment_grant.created", "partner_app.install.environment_grant.revoked", "partner_app.install.permissions_updated", "partner_app.install.revoked", "partner_app.install.updated", "payment_intent.canceled", "payment_intent.fulfillment_hold.updated", "payment_intent.payment_failed", "payment_intent.processing", "payment_intent.requires_action", "payment_intent.requires_capture", "payment_intent.succeeded", "payment_method.failed", "payment_method.removed", "payment_method.saved", "payout.canceled", "payout.created", "payout.failed", "payout.paid", "payout.reversed", "payout.updated", "payout_destination.created", "payout_destination.deleted", "payout_destination.disabled", "payout_destination.updated", "payout_settings.updated", "refund.created", "refund.failed", "refund.updated", "report.failed", "report.succeeded", "return.canceled", "return.completed", "return.created", "return.decision_recorded", "return.reopened", "return.updated", "return_disposition.created", "return_disposition.updated", "return_inspection.acceptance_decided", "return_inspection.created", "return_inspection.superseded", "return_receipt.created", "return_receipt.superseded", "return_receipt.verified", "return_resolution.created", "return_resolution.updated", "review.closed", "review.opened", "subscription.activated", "subscription.canceled", "subscription.created", "subscription.dunning_exhausted", "subscription.past_due", "subscription.paused", "subscription.payment_failed", "subscription.payment_succeeded", "subscription.renewal_upcoming", "subscription.resumed", "subscription.trial_ending", "subscription.updated". |
19599
+ | `event_type` | Optional | string | Values: "balance.updated", "balance_transaction.created", "balance_transaction.updated", "capability.updated", "checkout_session.closed", "checkout_session.completed", "checkout_session.expired", "checkout_session.invalidated", "credit_note.allocation_created", "credit_note.allocation_reversed", "credit_note.created", "credit_note.issued", "credit_note.updated", "credit_note.voided", "customer.created", "customer.deletion_completed", "customer.deletion_rejected", "customer.deletion_requested", "customer.updated", "delivery_location_set.activated", "delivery_location_set.archived", "delivery_location_set.created", "delivery_location_set.deactivated", "delivery_location_set.updated", "delivery_method.activated", "delivery_method.archived", "delivery_method.created", "delivery_method.deactivated", "delivery_method.updated", "delivery_profile.activated", "delivery_profile.archived", "delivery_profile.created", "delivery_profile.deactivated", "delivery_profile.updated", "delivery_rate.archived", "delivery_rate.created", "delivery_rate.updated", "delivery_rate_callback.activated", "delivery_rate_callback.archived", "delivery_rate_callback.created", "delivery_rate_callback.deactivated", "delivery_rate_callback.updated", "delivery_revocation.created", "delivery_selection.committed", "delivery_zone.activated", "delivery_zone.archived", "delivery_zone.created", "delivery_zone.deactivated", "delivery_zone.updated", "dispute.closed", "dispute.created", "dispute.lost", "dispute.needs_response", "dispute.prevented", "dispute.updated", "dispute.warning_closed", "dispute.won", "fraud_warning.created", "fraud_warning.updated", "inventory.action_required", "inventory.count.applied", "inventory.level.updated", "inventory.receipt.created", "inventory.reservation.at_risk", "inventory.reservation.closed", "inventory.reservation.committed", "inventory.reservation.consumed", "inventory.reservation.created", "inventory.reservation.hold_expired", "inventory.reservation.released", "inventory.shortage.detected", "inventory.transfer.closed", "inventory.transfer.departed", "inventory.transfer.lost", "inventory.transfer.received", "inventory.transfer.returned", "invoice.collection_block_resolved", "invoice.collection_blocked", "invoice.created", "invoice.credited", "invoice.delivery_failed", "invoice.delivery_succeeded", "invoice.issue_failed", "invoice.issued", "invoice.late_fee_assessed", "invoice.late_fee_due", "invoice.late_fee_waived", "invoice.manual_payment_recorded", "invoice.manual_payment_reversed", "invoice.marked_uncollectible", "invoice.overdue", "invoice.paid", "invoice.partially_paid", "invoice.partially_refunded", "invoice.payment_attempt_canceled", "invoice.payment_attempt_expired", "invoice.payment_failed", "invoice.payment_processing", "invoice.refunded", "invoice.reminder_due", "invoice.sent", "invoice.updated", "invoice.voided", "merchant.readiness.updated", "merchant_billing_balance.updated", "merchant_subscription_invoice.issued", "merchant_subscription_invoice.updated", "order.closed", "order.created", "order.fulfillment.completed", "order.fulfillment.created", "order.fulfillment.event.created", "order.fulfillment.package.created", "order.fulfillment.package.updated", "order.fulfillment.shipment.created", "order.fulfillment.shipment.updated", "order.fulfillment.status_changed", "order.fulfillment.updated", "order.inventory_action_required", "order.inventory_exception.created", "order.inventory_exception.resolved", "order.paid", "order.partially_paid", "order.payment_authorization_canceled", "order.payment_authorization_expired", "order.payment_authorized", "order.payment_captured", "order.refunded", "order.updated", "partner_app.install.created", "partner_app.install.environment_grant.created", "partner_app.install.environment_grant.revoked", "partner_app.install.permissions_updated", "partner_app.install.revoked", "partner_app.install.updated", "payment_intent.canceled", "payment_intent.fulfillment_hold.updated", "payment_intent.payment_failed", "payment_intent.processing", "payment_intent.requires_action", "payment_intent.requires_capture", "payment_intent.succeeded", "payment_method.failed", "payment_method.removed", "payment_method.saved", "payout.canceled", "payout.created", "payout.failed", "payout.paid", "payout.reversed", "payout.updated", "payout_destination.created", "payout_destination.deleted", "payout_destination.disabled", "payout_destination.updated", "payout_settings.updated", "refund.created", "refund.failed", "refund.updated", "report.failed", "report.succeeded", "return.canceled", "return.completed", "return.created", "return.decision_recorded", "return.reopened", "return.updated", "return_disposition.created", "return_disposition.updated", "return_inspection.acceptance_decided", "return_inspection.created", "return_inspection.superseded", "return_receipt.created", "return_receipt.superseded", "return_receipt.verified", "return_resolution.created", "return_resolution.updated", "review.closed", "review.opened", "subscription.activated", "subscription.canceled", "subscription.created", "subscription.dunning_exhausted", "subscription.past_due", "subscription.paused", "subscription.payment_failed", "subscription.payment_succeeded", "subscription.renewal_upcoming", "subscription.resumed", "subscription.trial_ending", "subscription.updated". |
19428
19600
  | `resource_type` | Optional | string | Values: "balance", "balance_transaction", "capability", "checkout_session", "customer", "dispute", "fraud_warning", "invoice", "merchant", "inventory_count", "inventory_level", "inventory_reservation", "inventory_reservation_line", "inventory_receipt", "inventory_transfer", "order", "payment_intent", "payment_method", "payout", "payout_destination", "payout_settings", "refund", "return", "return_disposition", "return_inspection", "return_receipt", "return_resolution", "review", "subscription". |
19429
19601
  | `resource_id` | Optional | string | |
19430
19602
  | `api_request_log_id` | Optional | string | |
@@ -19540,17 +19712,17 @@ Streams canonical merchant webhook events created after the connection opens or
19540
19712
 
19541
19713
  `GET /v1/webhook-events/stream`
19542
19714
 
19543
- Call: `stream(params?: { "event_type"?: InputValue<"balance.updated" | "balance_transaction.created" | "balance_transaction.updated" | "capability.updated" | "checkout_session.closed" | "checkout_session.completed" | "checkout_session.expired" | "checkout_session.invalidated" | "credit_note.allocation_created" | "credit_note.allocation_reversed" | "credit_note.created" | "credit_note.issued" | "credit_note.updated" | "credit_note.voided" | "customer.created" | "customer.deletion_completed" | "customer.deletion_rejected" | "customer.deletion_requested" | "customer.updated" | "delivery_location_set.activated" | "delivery_location_set.archived" | "delivery_location_set.created" | "delivery_location_set.deactivated" | "delivery_location_set.updated" | "delivery_method.activated" | "delivery_method.archived" | "delivery_method.created" | "delivery_method.deactivated" | "delivery_method.updated" | "delivery_profile.activated" | "delivery_profile.archived" | "delivery_profile.created" | "delivery_profile.deactivated" | "delivery_profile.updated" | "delivery_rate.archived" | "delivery_rate.created" | "delivery_rate.updated" | "delivery_rate_callback.activated" | "delivery_rate_callback.archived" | "delivery_rate_callback.created" | "delivery_rate_callback.deactivated" | "delivery_rate_callback.updated" | "delivery_revocation.created" | "delivery_selection.committed" | "delivery_zone.activated" | "delivery_zone.archived" | "delivery_zone.created" | "delivery_zone.deactivated" | "delivery_zone.updated" | "dispute.closed" | "dispute.created" | "dispute.lost" | "dispute.needs_response" | "dispute.prevented" | "dispute.updated" | "dispute.warning_closed" | "dispute.won" | "fraud_warning.created" | "fraud_warning.updated" | "inventory.action_required" | "inventory.count.applied" | "inventory.level.updated" | "inventory.receipt.created" | "inventory.reservation.at_risk" | "inventory.reservation.closed" | "inventory.reservation.committed" | "inventory.reservation.consumed" | "inventory.reservation.created" | "inventory.reservation.hold_expired" | "inventory.reservation.released" | "inventory.shortage.detected" | "inventory.transfer.closed" | "inventory.transfer.departed" | "inventory.transfer.lost" | "inventory.transfer.received" | "inventory.transfer.returned" | "invoice.collection_block_resolved" | "invoice.collection_blocked" | "invoice.created" | "invoice.credited" | "invoice.delivery_failed" | "invoice.delivery_succeeded" | "invoice.issue_failed" | "invoice.issued" | "invoice.late_fee_due" | "invoice.manual_payment_recorded" | "invoice.manual_payment_reversed" | "invoice.marked_uncollectible" | "invoice.overdue" | "invoice.paid" | "invoice.partially_paid" | "invoice.partially_refunded" | "invoice.payment_attempt_canceled" | "invoice.payment_attempt_expired" | "invoice.payment_failed" | "invoice.payment_processing" | "invoice.refunded" | "invoice.reminder_due" | "invoice.sent" | "invoice.updated" | "invoice.voided" | "merchant.readiness.updated" | "merchant_billing_balance.updated" | "merchant_subscription_invoice.issued" | "merchant_subscription_invoice.updated" | "order.closed" | "order.created" | "order.fulfillment.completed" | "order.fulfillment.created" | "order.fulfillment.event.created" | "order.fulfillment.package.created" | "order.fulfillment.package.updated" | "order.fulfillment.shipment.created" | "order.fulfillment.shipment.updated" | "order.fulfillment.status_changed" | "order.fulfillment.updated" | "order.inventory_action_required" | "order.inventory_exception.created" | "order.inventory_exception.resolved" | "order.paid" | "order.partially_paid" | "order.payment_authorization_canceled" | "order.payment_authorization_expired" | "order.payment_authorized" | "order.payment_captured" | "order.refunded" | "order.updated" | "payment_intent.canceled" | "payment_intent.fulfillment_hold.updated" | "payment_intent.payment_failed" | "payment_intent.processing" | "payment_intent.requires_action" | "payment_intent.requires_capture" | "payment_intent.succeeded" | "payment_method.failed" | "payment_method.removed" | "payment_method.saved" | "payout.canceled" | "payout.created" | "payout.failed" | "payout.paid" | "payout.reversed" | "payout.updated" | "payout_destination.created" | "payout_destination.deleted" | "payout_destination.disabled" | "payout_destination.updated" | "payout_settings.updated" | "refund.created" | "refund.failed" | "refund.updated" | "report.failed" | "report.succeeded" | "return.canceled" | "return.completed" | "return.created" | "return.decision_recorded" | "return.reopened" | "return.updated" | "return_disposition.created" | "return_disposition.updated" | "return_inspection.acceptance_decided" | "return_inspection.created" | "return_inspection.superseded" | "return_receipt.created" | "return_receipt.superseded" | "return_receipt.verified" | "return_resolution.created" | "return_resolution.updated" | "review.closed" | "review.opened" | "subscription.activated" | "subscription.canceled" | "subscription.created" | "subscription.dunning_exhausted" | "subscription.past_due" | "subscription.paused" | "subscription.payment_failed" | "subscription.payment_succeeded" | "subscription.renewal_upcoming" | "subscription.resumed" | "subscription.trial_ending" | "subscription.updated">; "after_event_id"?: InputValue<string>; "Last-Event-ID"?: InputValue<string>; "Flint-Version"?: InputValue<string> }, options?: RequestOptions<"merchant" | "merchantKey">)`
19715
+ Call: `stream(params?: { "event_type"?: InputValue<"balance.updated" | "balance_transaction.created" | "balance_transaction.updated" | "capability.updated" | "checkout_session.closed" | "checkout_session.completed" | "checkout_session.expired" | "checkout_session.invalidated" | "credit_note.allocation_created" | "credit_note.allocation_reversed" | "credit_note.created" | "credit_note.issued" | "credit_note.updated" | "credit_note.voided" | "customer.created" | "customer.deletion_completed" | "customer.deletion_rejected" | "customer.deletion_requested" | "customer.updated" | "delivery_location_set.activated" | "delivery_location_set.archived" | "delivery_location_set.created" | "delivery_location_set.deactivated" | "delivery_location_set.updated" | "delivery_method.activated" | "delivery_method.archived" | "delivery_method.created" | "delivery_method.deactivated" | "delivery_method.updated" | "delivery_profile.activated" | "delivery_profile.archived" | "delivery_profile.created" | "delivery_profile.deactivated" | "delivery_profile.updated" | "delivery_rate.archived" | "delivery_rate.created" | "delivery_rate.updated" | "delivery_rate_callback.activated" | "delivery_rate_callback.archived" | "delivery_rate_callback.created" | "delivery_rate_callback.deactivated" | "delivery_rate_callback.updated" | "delivery_revocation.created" | "delivery_selection.committed" | "delivery_zone.activated" | "delivery_zone.archived" | "delivery_zone.created" | "delivery_zone.deactivated" | "delivery_zone.updated" | "dispute.closed" | "dispute.created" | "dispute.lost" | "dispute.needs_response" | "dispute.prevented" | "dispute.updated" | "dispute.warning_closed" | "dispute.won" | "fraud_warning.created" | "fraud_warning.updated" | "inventory.action_required" | "inventory.count.applied" | "inventory.level.updated" | "inventory.receipt.created" | "inventory.reservation.at_risk" | "inventory.reservation.closed" | "inventory.reservation.committed" | "inventory.reservation.consumed" | "inventory.reservation.created" | "inventory.reservation.hold_expired" | "inventory.reservation.released" | "inventory.shortage.detected" | "inventory.transfer.closed" | "inventory.transfer.departed" | "inventory.transfer.lost" | "inventory.transfer.received" | "inventory.transfer.returned" | "invoice.collection_block_resolved" | "invoice.collection_blocked" | "invoice.created" | "invoice.credited" | "invoice.delivery_failed" | "invoice.delivery_succeeded" | "invoice.issue_failed" | "invoice.issued" | "invoice.late_fee_assessed" | "invoice.late_fee_due" | "invoice.late_fee_waived" | "invoice.manual_payment_recorded" | "invoice.manual_payment_reversed" | "invoice.marked_uncollectible" | "invoice.overdue" | "invoice.paid" | "invoice.partially_paid" | "invoice.partially_refunded" | "invoice.payment_attempt_canceled" | "invoice.payment_attempt_expired" | "invoice.payment_failed" | "invoice.payment_processing" | "invoice.refunded" | "invoice.reminder_due" | "invoice.sent" | "invoice.updated" | "invoice.voided" | "merchant.readiness.updated" | "merchant_billing_balance.updated" | "merchant_subscription_invoice.issued" | "merchant_subscription_invoice.updated" | "order.closed" | "order.created" | "order.fulfillment.completed" | "order.fulfillment.created" | "order.fulfillment.event.created" | "order.fulfillment.package.created" | "order.fulfillment.package.updated" | "order.fulfillment.shipment.created" | "order.fulfillment.shipment.updated" | "order.fulfillment.status_changed" | "order.fulfillment.updated" | "order.inventory_action_required" | "order.inventory_exception.created" | "order.inventory_exception.resolved" | "order.paid" | "order.partially_paid" | "order.payment_authorization_canceled" | "order.payment_authorization_expired" | "order.payment_authorized" | "order.payment_captured" | "order.refunded" | "order.updated" | "payment_intent.canceled" | "payment_intent.fulfillment_hold.updated" | "payment_intent.payment_failed" | "payment_intent.processing" | "payment_intent.requires_action" | "payment_intent.requires_capture" | "payment_intent.succeeded" | "payment_method.failed" | "payment_method.removed" | "payment_method.saved" | "payout.canceled" | "payout.created" | "payout.failed" | "payout.paid" | "payout.reversed" | "payout.updated" | "payout_destination.created" | "payout_destination.deleted" | "payout_destination.disabled" | "payout_destination.updated" | "payout_settings.updated" | "refund.created" | "refund.failed" | "refund.updated" | "report.failed" | "report.succeeded" | "return.canceled" | "return.completed" | "return.created" | "return.decision_recorded" | "return.reopened" | "return.updated" | "return_disposition.created" | "return_disposition.updated" | "return_inspection.acceptance_decided" | "return_inspection.created" | "return_inspection.superseded" | "return_receipt.created" | "return_receipt.superseded" | "return_receipt.verified" | "return_resolution.created" | "return_resolution.updated" | "review.closed" | "review.opened" | "subscription.activated" | "subscription.canceled" | "subscription.created" | "subscription.dunning_exhausted" | "subscription.past_due" | "subscription.paused" | "subscription.payment_failed" | "subscription.payment_succeeded" | "subscription.renewal_upcoming" | "subscription.resumed" | "subscription.trial_ending" | "subscription.updated">; "after_event_id"?: InputValue<string>; "Last-Event-ID"?: InputValue<string>; "Flint-Version"?: InputValue<string> }, options?: RequestOptions<"merchant" | "merchantKey">)`
19544
19716
 
19545
19717
  Path arguments: none. Params contain flat body fields and query/header fields.
19546
19718
 
19547
- Canonical input schema (for configuration examples and HTTP fixtures): `{ "event_type"?: "balance.updated" | "balance_transaction.created" | "balance_transaction.updated" | "capability.updated" | "checkout_session.closed" | "checkout_session.completed" | "checkout_session.expired" | "checkout_session.invalidated" | "credit_note.allocation_created" | "credit_note.allocation_reversed" | "credit_note.created" | "credit_note.issued" | "credit_note.updated" | "credit_note.voided" | "customer.created" | "customer.deletion_completed" | "customer.deletion_rejected" | "customer.deletion_requested" | "customer.updated" | "delivery_location_set.activated" | "delivery_location_set.archived" | "delivery_location_set.created" | "delivery_location_set.deactivated" | "delivery_location_set.updated" | "delivery_method.activated" | "delivery_method.archived" | "delivery_method.created" | "delivery_method.deactivated" | "delivery_method.updated" | "delivery_profile.activated" | "delivery_profile.archived" | "delivery_profile.created" | "delivery_profile.deactivated" | "delivery_profile.updated" | "delivery_rate.archived" | "delivery_rate.created" | "delivery_rate.updated" | "delivery_rate_callback.activated" | "delivery_rate_callback.archived" | "delivery_rate_callback.created" | "delivery_rate_callback.deactivated" | "delivery_rate_callback.updated" | "delivery_revocation.created" | "delivery_selection.committed" | "delivery_zone.activated" | "delivery_zone.archived" | "delivery_zone.created" | "delivery_zone.deactivated" | "delivery_zone.updated" | "dispute.closed" | "dispute.created" | "dispute.lost" | "dispute.needs_response" | "dispute.prevented" | "dispute.updated" | "dispute.warning_closed" | "dispute.won" | "fraud_warning.created" | "fraud_warning.updated" | "inventory.action_required" | "inventory.count.applied" | "inventory.level.updated" | "inventory.receipt.created" | "inventory.reservation.at_risk" | "inventory.reservation.closed" | "inventory.reservation.committed" | "inventory.reservation.consumed" | "inventory.reservation.created" | "inventory.reservation.hold_expired" | "inventory.reservation.released" | "inventory.shortage.detected" | "inventory.transfer.closed" | "inventory.transfer.departed" | "inventory.transfer.lost" | "inventory.transfer.received" | "inventory.transfer.returned" | "invoice.collection_block_resolved" | "invoice.collection_blocked" | "invoice.created" | "invoice.credited" | "invoice.delivery_failed" | "invoice.delivery_succeeded" | "invoice.issue_failed" | "invoice.issued" | "invoice.late_fee_due" | "invoice.manual_payment_recorded" | "invoice.manual_payment_reversed" | "invoice.marked_uncollectible" | "invoice.overdue" | "invoice.paid" | "invoice.partially_paid" | "invoice.partially_refunded" | "invoice.payment_attempt_canceled" | "invoice.payment_attempt_expired" | "invoice.payment_failed" | "invoice.payment_processing" | "invoice.refunded" | "invoice.reminder_due" | "invoice.sent" | "invoice.updated" | "invoice.voided" | "merchant.readiness.updated" | "merchant_billing_balance.updated" | "merchant_subscription_invoice.issued" | "merchant_subscription_invoice.updated" | "order.closed" | "order.created" | "order.fulfillment.completed" | "order.fulfillment.created" | "order.fulfillment.event.created" | "order.fulfillment.package.created" | "order.fulfillment.package.updated" | "order.fulfillment.shipment.created" | "order.fulfillment.shipment.updated" | "order.fulfillment.status_changed" | "order.fulfillment.updated" | "order.inventory_action_required" | "order.inventory_exception.created" | "order.inventory_exception.resolved" | "order.paid" | "order.partially_paid" | "order.payment_authorization_canceled" | "order.payment_authorization_expired" | "order.payment_authorized" | "order.payment_captured" | "order.refunded" | "order.updated" | "payment_intent.canceled" | "payment_intent.fulfillment_hold.updated" | "payment_intent.payment_failed" | "payment_intent.processing" | "payment_intent.requires_action" | "payment_intent.requires_capture" | "payment_intent.succeeded" | "payment_method.failed" | "payment_method.removed" | "payment_method.saved" | "payout.canceled" | "payout.created" | "payout.failed" | "payout.paid" | "payout.reversed" | "payout.updated" | "payout_destination.created" | "payout_destination.deleted" | "payout_destination.disabled" | "payout_destination.updated" | "payout_settings.updated" | "refund.created" | "refund.failed" | "refund.updated" | "report.failed" | "report.succeeded" | "return.canceled" | "return.completed" | "return.created" | "return.decision_recorded" | "return.reopened" | "return.updated" | "return_disposition.created" | "return_disposition.updated" | "return_inspection.acceptance_decided" | "return_inspection.created" | "return_inspection.superseded" | "return_receipt.created" | "return_receipt.superseded" | "return_receipt.verified" | "return_resolution.created" | "return_resolution.updated" | "review.closed" | "review.opened" | "subscription.activated" | "subscription.canceled" | "subscription.created" | "subscription.dunning_exhausted" | "subscription.past_due" | "subscription.paused" | "subscription.payment_failed" | "subscription.payment_succeeded" | "subscription.renewal_upcoming" | "subscription.resumed" | "subscription.trial_ending" | "subscription.updated"; "after_event_id"?: string; "Last-Event-ID"?: string; "Flint-Version"?: string; }`
19719
+ Canonical input schema (for configuration examples and HTTP fixtures): `{ "event_type"?: "balance.updated" | "balance_transaction.created" | "balance_transaction.updated" | "capability.updated" | "checkout_session.closed" | "checkout_session.completed" | "checkout_session.expired" | "checkout_session.invalidated" | "credit_note.allocation_created" | "credit_note.allocation_reversed" | "credit_note.created" | "credit_note.issued" | "credit_note.updated" | "credit_note.voided" | "customer.created" | "customer.deletion_completed" | "customer.deletion_rejected" | "customer.deletion_requested" | "customer.updated" | "delivery_location_set.activated" | "delivery_location_set.archived" | "delivery_location_set.created" | "delivery_location_set.deactivated" | "delivery_location_set.updated" | "delivery_method.activated" | "delivery_method.archived" | "delivery_method.created" | "delivery_method.deactivated" | "delivery_method.updated" | "delivery_profile.activated" | "delivery_profile.archived" | "delivery_profile.created" | "delivery_profile.deactivated" | "delivery_profile.updated" | "delivery_rate.archived" | "delivery_rate.created" | "delivery_rate.updated" | "delivery_rate_callback.activated" | "delivery_rate_callback.archived" | "delivery_rate_callback.created" | "delivery_rate_callback.deactivated" | "delivery_rate_callback.updated" | "delivery_revocation.created" | "delivery_selection.committed" | "delivery_zone.activated" | "delivery_zone.archived" | "delivery_zone.created" | "delivery_zone.deactivated" | "delivery_zone.updated" | "dispute.closed" | "dispute.created" | "dispute.lost" | "dispute.needs_response" | "dispute.prevented" | "dispute.updated" | "dispute.warning_closed" | "dispute.won" | "fraud_warning.created" | "fraud_warning.updated" | "inventory.action_required" | "inventory.count.applied" | "inventory.level.updated" | "inventory.receipt.created" | "inventory.reservation.at_risk" | "inventory.reservation.closed" | "inventory.reservation.committed" | "inventory.reservation.consumed" | "inventory.reservation.created" | "inventory.reservation.hold_expired" | "inventory.reservation.released" | "inventory.shortage.detected" | "inventory.transfer.closed" | "inventory.transfer.departed" | "inventory.transfer.lost" | "inventory.transfer.received" | "inventory.transfer.returned" | "invoice.collection_block_resolved" | "invoice.collection_blocked" | "invoice.created" | "invoice.credited" | "invoice.delivery_failed" | "invoice.delivery_succeeded" | "invoice.issue_failed" | "invoice.issued" | "invoice.late_fee_assessed" | "invoice.late_fee_due" | "invoice.late_fee_waived" | "invoice.manual_payment_recorded" | "invoice.manual_payment_reversed" | "invoice.marked_uncollectible" | "invoice.overdue" | "invoice.paid" | "invoice.partially_paid" | "invoice.partially_refunded" | "invoice.payment_attempt_canceled" | "invoice.payment_attempt_expired" | "invoice.payment_failed" | "invoice.payment_processing" | "invoice.refunded" | "invoice.reminder_due" | "invoice.sent" | "invoice.updated" | "invoice.voided" | "merchant.readiness.updated" | "merchant_billing_balance.updated" | "merchant_subscription_invoice.issued" | "merchant_subscription_invoice.updated" | "order.closed" | "order.created" | "order.fulfillment.completed" | "order.fulfillment.created" | "order.fulfillment.event.created" | "order.fulfillment.package.created" | "order.fulfillment.package.updated" | "order.fulfillment.shipment.created" | "order.fulfillment.shipment.updated" | "order.fulfillment.status_changed" | "order.fulfillment.updated" | "order.inventory_action_required" | "order.inventory_exception.created" | "order.inventory_exception.resolved" | "order.paid" | "order.partially_paid" | "order.payment_authorization_canceled" | "order.payment_authorization_expired" | "order.payment_authorized" | "order.payment_captured" | "order.refunded" | "order.updated" | "payment_intent.canceled" | "payment_intent.fulfillment_hold.updated" | "payment_intent.payment_failed" | "payment_intent.processing" | "payment_intent.requires_action" | "payment_intent.requires_capture" | "payment_intent.succeeded" | "payment_method.failed" | "payment_method.removed" | "payment_method.saved" | "payout.canceled" | "payout.created" | "payout.failed" | "payout.paid" | "payout.reversed" | "payout.updated" | "payout_destination.created" | "payout_destination.deleted" | "payout_destination.disabled" | "payout_destination.updated" | "payout_settings.updated" | "refund.created" | "refund.failed" | "refund.updated" | "report.failed" | "report.succeeded" | "return.canceled" | "return.completed" | "return.created" | "return.decision_recorded" | "return.reopened" | "return.updated" | "return_disposition.created" | "return_disposition.updated" | "return_inspection.acceptance_decided" | "return_inspection.created" | "return_inspection.superseded" | "return_receipt.created" | "return_receipt.superseded" | "return_receipt.verified" | "return_resolution.created" | "return_resolution.updated" | "review.closed" | "review.opened" | "subscription.activated" | "subscription.canceled" | "subscription.created" | "subscription.dunning_exhausted" | "subscription.past_due" | "subscription.paused" | "subscription.payment_failed" | "subscription.payment_succeeded" | "subscription.renewal_upcoming" | "subscription.resumed" | "subscription.trial_ending" | "subscription.updated"; "after_event_id"?: string; "Last-Event-ID"?: string; "Flint-Version"?: string; }`
19548
19720
 
19549
19721
  Response body (inside Result.data): `EventStream`
19550
19722
 
19551
19723
  | Field | Presence | Type | Description |
19552
19724
  | --- | --- | --- | --- |
19553
- | `event_type` | Optional | string | Values: "balance.updated", "balance_transaction.created", "balance_transaction.updated", "capability.updated", "checkout_session.closed", "checkout_session.completed", "checkout_session.expired", "checkout_session.invalidated", "credit_note.allocation_created", "credit_note.allocation_reversed", "credit_note.created", "credit_note.issued", "credit_note.updated", "credit_note.voided", "customer.created", "customer.deletion_completed", "customer.deletion_rejected", "customer.deletion_requested", "customer.updated", "delivery_location_set.activated", "delivery_location_set.archived", "delivery_location_set.created", "delivery_location_set.deactivated", "delivery_location_set.updated", "delivery_method.activated", "delivery_method.archived", "delivery_method.created", "delivery_method.deactivated", "delivery_method.updated", "delivery_profile.activated", "delivery_profile.archived", "delivery_profile.created", "delivery_profile.deactivated", "delivery_profile.updated", "delivery_rate.archived", "delivery_rate.created", "delivery_rate.updated", "delivery_rate_callback.activated", "delivery_rate_callback.archived", "delivery_rate_callback.created", "delivery_rate_callback.deactivated", "delivery_rate_callback.updated", "delivery_revocation.created", "delivery_selection.committed", "delivery_zone.activated", "delivery_zone.archived", "delivery_zone.created", "delivery_zone.deactivated", "delivery_zone.updated", "dispute.closed", "dispute.created", "dispute.lost", "dispute.needs_response", "dispute.prevented", "dispute.updated", "dispute.warning_closed", "dispute.won", "fraud_warning.created", "fraud_warning.updated", "inventory.action_required", "inventory.count.applied", "inventory.level.updated", "inventory.receipt.created", "inventory.reservation.at_risk", "inventory.reservation.closed", "inventory.reservation.committed", "inventory.reservation.consumed", "inventory.reservation.created", "inventory.reservation.hold_expired", "inventory.reservation.released", "inventory.shortage.detected", "inventory.transfer.closed", "inventory.transfer.departed", "inventory.transfer.lost", "inventory.transfer.received", "inventory.transfer.returned", "invoice.collection_block_resolved", "invoice.collection_blocked", "invoice.created", "invoice.credited", "invoice.delivery_failed", "invoice.delivery_succeeded", "invoice.issue_failed", "invoice.issued", "invoice.late_fee_due", "invoice.manual_payment_recorded", "invoice.manual_payment_reversed", "invoice.marked_uncollectible", "invoice.overdue", "invoice.paid", "invoice.partially_paid", "invoice.partially_refunded", "invoice.payment_attempt_canceled", "invoice.payment_attempt_expired", "invoice.payment_failed", "invoice.payment_processing", "invoice.refunded", "invoice.reminder_due", "invoice.sent", "invoice.updated", "invoice.voided", "merchant.readiness.updated", "merchant_billing_balance.updated", "merchant_subscription_invoice.issued", "merchant_subscription_invoice.updated", "order.closed", "order.created", "order.fulfillment.completed", "order.fulfillment.created", "order.fulfillment.event.created", "order.fulfillment.package.created", "order.fulfillment.package.updated", "order.fulfillment.shipment.created", "order.fulfillment.shipment.updated", "order.fulfillment.status_changed", "order.fulfillment.updated", "order.inventory_action_required", "order.inventory_exception.created", "order.inventory_exception.resolved", "order.paid", "order.partially_paid", "order.payment_authorization_canceled", "order.payment_authorization_expired", "order.payment_authorized", "order.payment_captured", "order.refunded", "order.updated", "payment_intent.canceled", "payment_intent.fulfillment_hold.updated", "payment_intent.payment_failed", "payment_intent.processing", "payment_intent.requires_action", "payment_intent.requires_capture", "payment_intent.succeeded", "payment_method.failed", "payment_method.removed", "payment_method.saved", "payout.canceled", "payout.created", "payout.failed", "payout.paid", "payout.reversed", "payout.updated", "payout_destination.created", "payout_destination.deleted", "payout_destination.disabled", "payout_destination.updated", "payout_settings.updated", "refund.created", "refund.failed", "refund.updated", "report.failed", "report.succeeded", "return.canceled", "return.completed", "return.created", "return.decision_recorded", "return.reopened", "return.updated", "return_disposition.created", "return_disposition.updated", "return_inspection.acceptance_decided", "return_inspection.created", "return_inspection.superseded", "return_receipt.created", "return_receipt.superseded", "return_receipt.verified", "return_resolution.created", "return_resolution.updated", "review.closed", "review.opened", "subscription.activated", "subscription.canceled", "subscription.created", "subscription.dunning_exhausted", "subscription.past_due", "subscription.paused", "subscription.payment_failed", "subscription.payment_succeeded", "subscription.renewal_upcoming", "subscription.resumed", "subscription.trial_ending", "subscription.updated". |
19725
+ | `event_type` | Optional | string | Values: "balance.updated", "balance_transaction.created", "balance_transaction.updated", "capability.updated", "checkout_session.closed", "checkout_session.completed", "checkout_session.expired", "checkout_session.invalidated", "credit_note.allocation_created", "credit_note.allocation_reversed", "credit_note.created", "credit_note.issued", "credit_note.updated", "credit_note.voided", "customer.created", "customer.deletion_completed", "customer.deletion_rejected", "customer.deletion_requested", "customer.updated", "delivery_location_set.activated", "delivery_location_set.archived", "delivery_location_set.created", "delivery_location_set.deactivated", "delivery_location_set.updated", "delivery_method.activated", "delivery_method.archived", "delivery_method.created", "delivery_method.deactivated", "delivery_method.updated", "delivery_profile.activated", "delivery_profile.archived", "delivery_profile.created", "delivery_profile.deactivated", "delivery_profile.updated", "delivery_rate.archived", "delivery_rate.created", "delivery_rate.updated", "delivery_rate_callback.activated", "delivery_rate_callback.archived", "delivery_rate_callback.created", "delivery_rate_callback.deactivated", "delivery_rate_callback.updated", "delivery_revocation.created", "delivery_selection.committed", "delivery_zone.activated", "delivery_zone.archived", "delivery_zone.created", "delivery_zone.deactivated", "delivery_zone.updated", "dispute.closed", "dispute.created", "dispute.lost", "dispute.needs_response", "dispute.prevented", "dispute.updated", "dispute.warning_closed", "dispute.won", "fraud_warning.created", "fraud_warning.updated", "inventory.action_required", "inventory.count.applied", "inventory.level.updated", "inventory.receipt.created", "inventory.reservation.at_risk", "inventory.reservation.closed", "inventory.reservation.committed", "inventory.reservation.consumed", "inventory.reservation.created", "inventory.reservation.hold_expired", "inventory.reservation.released", "inventory.shortage.detected", "inventory.transfer.closed", "inventory.transfer.departed", "inventory.transfer.lost", "inventory.transfer.received", "inventory.transfer.returned", "invoice.collection_block_resolved", "invoice.collection_blocked", "invoice.created", "invoice.credited", "invoice.delivery_failed", "invoice.delivery_succeeded", "invoice.issue_failed", "invoice.issued", "invoice.late_fee_assessed", "invoice.late_fee_due", "invoice.late_fee_waived", "invoice.manual_payment_recorded", "invoice.manual_payment_reversed", "invoice.marked_uncollectible", "invoice.overdue", "invoice.paid", "invoice.partially_paid", "invoice.partially_refunded", "invoice.payment_attempt_canceled", "invoice.payment_attempt_expired", "invoice.payment_failed", "invoice.payment_processing", "invoice.refunded", "invoice.reminder_due", "invoice.sent", "invoice.updated", "invoice.voided", "merchant.readiness.updated", "merchant_billing_balance.updated", "merchant_subscription_invoice.issued", "merchant_subscription_invoice.updated", "order.closed", "order.created", "order.fulfillment.completed", "order.fulfillment.created", "order.fulfillment.event.created", "order.fulfillment.package.created", "order.fulfillment.package.updated", "order.fulfillment.shipment.created", "order.fulfillment.shipment.updated", "order.fulfillment.status_changed", "order.fulfillment.updated", "order.inventory_action_required", "order.inventory_exception.created", "order.inventory_exception.resolved", "order.paid", "order.partially_paid", "order.payment_authorization_canceled", "order.payment_authorization_expired", "order.payment_authorized", "order.payment_captured", "order.refunded", "order.updated", "payment_intent.canceled", "payment_intent.fulfillment_hold.updated", "payment_intent.payment_failed", "payment_intent.processing", "payment_intent.requires_action", "payment_intent.requires_capture", "payment_intent.succeeded", "payment_method.failed", "payment_method.removed", "payment_method.saved", "payout.canceled", "payout.created", "payout.failed", "payout.paid", "payout.reversed", "payout.updated", "payout_destination.created", "payout_destination.deleted", "payout_destination.disabled", "payout_destination.updated", "payout_settings.updated", "refund.created", "refund.failed", "refund.updated", "report.failed", "report.succeeded", "return.canceled", "return.completed", "return.created", "return.decision_recorded", "return.reopened", "return.updated", "return_disposition.created", "return_disposition.updated", "return_inspection.acceptance_decided", "return_inspection.created", "return_inspection.superseded", "return_receipt.created", "return_receipt.superseded", "return_receipt.verified", "return_resolution.created", "return_resolution.updated", "review.closed", "review.opened", "subscription.activated", "subscription.canceled", "subscription.created", "subscription.dunning_exhausted", "subscription.past_due", "subscription.paused", "subscription.payment_failed", "subscription.payment_succeeded", "subscription.renewal_upcoming", "subscription.resumed", "subscription.trial_ending", "subscription.updated". |
19554
19726
  | `after_event_id` | Optional | string | |
19555
19727
  | `Last-Event-ID` | Optional | string | |
19556
19728
  | `Flint-Version` | Optional | string | Format: date. |