@peable.to/contracts 2.0.0 → 3.1.0

package/dist/types/resources/payments/index.d.ts

@@ -176,8 +176,8 @@ export declare const paymentsRoutes: readonly [{
         cancellation_reason: import("zod").ZodNullable<import("zod").ZodEnum<{
             duplicate: "duplicate";
             fraudulent: "fraudulent";
-            automatic: "automatic";
             abandoned: "abandoned";
+            automatic: "automatic";
             requested_by_customer: "requested_by_customer";
             underpaid: "underpaid";
         }>>;
@@ -358,8 +358,8 @@ export declare const paymentsRoutes: readonly [{
             cancellation_reason: import("zod").ZodNullable<import("zod").ZodEnum<{
                 duplicate: "duplicate";
                 fraudulent: "fraudulent";
-                automatic: "automatic";
                 abandoned: "abandoned";
+                automatic: "automatic";
                 requested_by_customer: "requested_by_customer";
                 underpaid: "underpaid";
             }>>;
@@ -521,8 +521,8 @@ export declare const paymentsRoutes: readonly [{
         cancellation_reason: import("zod").ZodNullable<import("zod").ZodEnum<{
             duplicate: "duplicate";
             fraudulent: "fraudulent";
-            automatic: "automatic";
             abandoned: "abandoned";
+            automatic: "automatic";
             requested_by_customer: "requested_by_customer";
             underpaid: "underpaid";
         }>>;
@@ -698,8 +698,8 @@ export declare const paymentsRoutes: readonly [{
         cancellation_reason: import("zod").ZodNullable<import("zod").ZodEnum<{
             duplicate: "duplicate";
             fraudulent: "fraudulent";
-            automatic: "automatic";
             abandoned: "abandoned";
+            automatic: "automatic";
             requested_by_customer: "requested_by_customer";
             underpaid: "underpaid";
         }>>;
@@ -905,8 +905,8 @@ export declare const paymentsRoutes: readonly [{
         cancellation_reason: import("zod").ZodNullable<import("zod").ZodEnum<{
             duplicate: "duplicate";
             fraudulent: "fraudulent";
-            automatic: "automatic";
             abandoned: "abandoned";
+            automatic: "automatic";
             requested_by_customer: "requested_by_customer";
             underpaid: "underpaid";
         }>>;
@@ -1066,8 +1066,8 @@ export declare const paymentsRoutes: readonly [{
         cancellation_reason: import("zod").ZodNullable<import("zod").ZodEnum<{
             duplicate: "duplicate";
             fraudulent: "fraudulent";
-            automatic: "automatic";
             abandoned: "abandoned";
+            automatic: "automatic";
             requested_by_customer: "requested_by_customer";
             underpaid: "underpaid";
         }>>;
@@ -1232,8 +1232,8 @@ export declare const paymentsRoutes: readonly [{
         cancellation_reason: import("zod").ZodNullable<import("zod").ZodEnum<{
             duplicate: "duplicate";
             fraudulent: "fraudulent";
-            automatic: "automatic";
             abandoned: "abandoned";
+            automatic: "automatic";
             requested_by_customer: "requested_by_customer";
             underpaid: "underpaid";
         }>>;
@@ -1391,8 +1391,8 @@ export declare const paymentsRoutes: readonly [{
         cancellation_reason: import("zod").ZodNullable<import("zod").ZodEnum<{
             duplicate: "duplicate";
             fraudulent: "fraudulent";
-            automatic: "automatic";
             abandoned: "abandoned";
+            automatic: "automatic";
             requested_by_customer: "requested_by_customer";
             underpaid: "underpaid";
         }>>;
@@ -1550,8 +1550,8 @@ export declare const paymentsRoutes: readonly [{
             cancellation_reason: import("zod").ZodNullable<import("zod").ZodEnum<{
                 duplicate: "duplicate";
                 fraudulent: "fraudulent";
-                automatic: "automatic";
                 abandoned: "abandoned";
+                automatic: "automatic";
                 requested_by_customer: "requested_by_customer";
                 underpaid: "underpaid";
             }>>;
@@ -2306,6 +2306,8 @@ export declare const paymentsRoutes: readonly [{
         object: import("zod").ZodLiteral<"settlement">;
         livemode: import("zod").ZodBoolean;
         payment_intent: import("zod").ZodType<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">, import("zod/v4/core").$ZodTypeInternals<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">>>;
+        refund: import("zod").ZodNullable<import("zod").ZodType<string | import("../..").Ref<"refund">, string | import("../..").Ref<"refund">, import("zod/v4/core").$ZodTypeInternals<string | import("../..").Ref<"refund">, string | import("../..").Ref<"refund">>>>;
+        dispute: import("zod").ZodNullable<import("zod").ZodType<string | import("../..").Ref<"dispute">, string | import("../..").Ref<"dispute">, import("zod/v4/core").$ZodTypeInternals<string | import("../..").Ref<"dispute">, string | import("../..").Ref<"dispute">>>>;
         status: import("zod").ZodEnum<{
             unknown: "unknown";
             pending: "pending";
@@ -2320,6 +2322,41 @@ export declare const paymentsRoutes: readonly [{
     }, import("zod/v4/core").$strict>;
     readonly sdk: "refunds.settlement";
     readonly expandable: "settlement";
+}, {
+    readonly operationId: "retrieveRefundSettlement";
+    readonly method: "get";
+    readonly path: "/v1/refunds/{id}/settlement";
+    readonly tag: "Refunds";
+    readonly summary: "Retrieve a refund's settlement";
+    readonly description: "What the refund took off the settlement balance — `gross`, `fee`, a negative `net` — in the settlement currency, read live from the provider. A missing figure is `null` with a `status`, never `0`; a refund that failed or was canceled is `unknown`.";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly params: {
+        id: string;
+    };
+    readonly query: import("zod").ZodObject<{
+        expand: import("zod").ZodOptional<import("zod").ZodPipe<import("zod").ZodPipe<import("zod").ZodUnion<readonly [import("zod").ZodString, import("zod").ZodArray<import("zod").ZodString>]>, import("zod").ZodTransform<string[], string | string[]>>, import("zod").ZodArray<import("zod").ZodString>>>;
+    }, import("zod/v4/core").$strict>;
+    readonly response: import("zod").ZodObject<{
+        object: import("zod").ZodLiteral<"settlement">;
+        livemode: import("zod").ZodBoolean;
+        payment_intent: import("zod").ZodType<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">, import("zod/v4/core").$ZodTypeInternals<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">>>;
+        refund: import("zod").ZodNullable<import("zod").ZodType<string | import("../..").Ref<"refund">, string | import("../..").Ref<"refund">, import("zod/v4/core").$ZodTypeInternals<string | import("../..").Ref<"refund">, string | import("../..").Ref<"refund">>>>;
+        dispute: import("zod").ZodNullable<import("zod").ZodType<string | import("../..").Ref<"dispute">, string | import("../..").Ref<"dispute">, import("zod/v4/core").$ZodTypeInternals<string | import("../..").Ref<"dispute">, string | import("../..").Ref<"dispute">>>>;
+        status: import("zod").ZodEnum<{
+            unknown: "unknown";
+            pending: "pending";
+            available: "available";
+        }>;
+        gross: import("zod").ZodNullable<import("zod").ZodString>;
+        fee: import("zod").ZodNullable<import("zod").ZodString>;
+        net: import("zod").ZodNullable<import("zod").ZodString>;
+        currency: import("zod").ZodNullable<import("zod").ZodString>;
+        available_on: import("zod").ZodNullable<import("zod").ZodNumber>;
+        exchange_rate: import("zod").ZodNullable<import("zod").ZodNumber>;
+    }, import("zod/v4/core").$strict>;
+    readonly sdk: "refunds.refundSettlement";
+    readonly expandable: "settlement";
 }, {
     readonly operationId: "searchRefunds";
     readonly method: "get";
@@ -2958,6 +2995,41 @@ export declare const paymentsRoutes: readonly [{
         updated_at: import("zod").ZodNumber;
     }, import("zod/v4/core").$strict>;
     readonly sdk: "disputes.close";
+}, {
+    readonly operationId: "retrieveDisputeSettlement";
+    readonly method: "get";
+    readonly path: "/v1/disputes/{disputeId}/settlement";
+    readonly tag: "Disputes";
+    readonly summary: "Retrieve a dispute's settlement";
+    readonly description: "What the dispute WITHDREW from the settlement balance — `gross` the principal, `fee` the dispute fee, a negative `net` — in the settlement currency, read live from the provider. An inquiry moves no money: `unknown`, every figure `null`, never `0`. A reinstatement after a won dispute is not this figure.";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly params: {
+        disputeId: string;
+    };
+    readonly query: import("zod").ZodObject<{
+        expand: import("zod").ZodOptional<import("zod").ZodPipe<import("zod").ZodPipe<import("zod").ZodUnion<readonly [import("zod").ZodString, import("zod").ZodArray<import("zod").ZodString>]>, import("zod").ZodTransform<string[], string | string[]>>, import("zod").ZodArray<import("zod").ZodString>>>;
+    }, import("zod/v4/core").$strict>;
+    readonly response: import("zod").ZodObject<{
+        object: import("zod").ZodLiteral<"settlement">;
+        livemode: import("zod").ZodBoolean;
+        payment_intent: import("zod").ZodType<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">, import("zod/v4/core").$ZodTypeInternals<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">>>;
+        refund: import("zod").ZodNullable<import("zod").ZodType<string | import("../..").Ref<"refund">, string | import("../..").Ref<"refund">, import("zod/v4/core").$ZodTypeInternals<string | import("../..").Ref<"refund">, string | import("../..").Ref<"refund">>>>;
+        dispute: import("zod").ZodNullable<import("zod").ZodType<string | import("../..").Ref<"dispute">, string | import("../..").Ref<"dispute">, import("zod/v4/core").$ZodTypeInternals<string | import("../..").Ref<"dispute">, string | import("../..").Ref<"dispute">>>>;
+        status: import("zod").ZodEnum<{
+            unknown: "unknown";
+            pending: "pending";
+            available: "available";
+        }>;
+        gross: import("zod").ZodNullable<import("zod").ZodString>;
+        fee: import("zod").ZodNullable<import("zod").ZodString>;
+        net: import("zod").ZodNullable<import("zod").ZodString>;
+        currency: import("zod").ZodNullable<import("zod").ZodString>;
+        available_on: import("zod").ZodNullable<import("zod").ZodNumber>;
+        exchange_rate: import("zod").ZodNullable<import("zod").ZodNumber>;
+    }, import("zod/v4/core").$strict>;
+    readonly sdk: "disputes.settlement";
+    readonly expandable: "settlement";
 }, {
     readonly operationId: "createSetupIntent";
     readonly method: "post";
@@ -3457,8 +3529,8 @@ export declare const paymentsRoutes: readonly [{
         cancellation_reason: import("zod").ZodNullable<import("zod").ZodEnum<{
             duplicate: "duplicate";
             fraudulent: "fraudulent";
-            automatic: "automatic";
             abandoned: "abandoned";
+            automatic: "automatic";
             requested_by_customer: "requested_by_customer";
             underpaid: "underpaid";
         }>>;

package/dist/types/resources/payments/paymentIntents.d.ts

@@ -174,8 +174,8 @@ export declare const paymentIntentSchema: z.ZodObject<{
     cancellation_reason: z.ZodNullable<z.ZodEnum<{
         duplicate: "duplicate";
         fraudulent: "fraudulent";
-        automatic: "automatic";
         abandoned: "abandoned";
+        automatic: "automatic";
         requested_by_customer: "requested_by_customer";
         underpaid: "underpaid";
     }>>;
@@ -640,8 +640,8 @@ export declare const paymentIntentRoutes: readonly [{
         cancellation_reason: z.ZodNullable<z.ZodEnum<{
             duplicate: "duplicate";
             fraudulent: "fraudulent";
-            automatic: "automatic";
             abandoned: "abandoned";
+            automatic: "automatic";
             requested_by_customer: "requested_by_customer";
             underpaid: "underpaid";
         }>>;
@@ -822,8 +822,8 @@ export declare const paymentIntentRoutes: readonly [{
             cancellation_reason: z.ZodNullable<z.ZodEnum<{
                 duplicate: "duplicate";
                 fraudulent: "fraudulent";
-                automatic: "automatic";
                 abandoned: "abandoned";
+                automatic: "automatic";
                 requested_by_customer: "requested_by_customer";
                 underpaid: "underpaid";
             }>>;
@@ -985,8 +985,8 @@ export declare const paymentIntentRoutes: readonly [{
         cancellation_reason: z.ZodNullable<z.ZodEnum<{
             duplicate: "duplicate";
             fraudulent: "fraudulent";
-            automatic: "automatic";
             abandoned: "abandoned";
+            automatic: "automatic";
             requested_by_customer: "requested_by_customer";
             underpaid: "underpaid";
         }>>;
@@ -1162,8 +1162,8 @@ export declare const paymentIntentRoutes: readonly [{
         cancellation_reason: z.ZodNullable<z.ZodEnum<{
             duplicate: "duplicate";
             fraudulent: "fraudulent";
-            automatic: "automatic";
             abandoned: "abandoned";
+            automatic: "automatic";
             requested_by_customer: "requested_by_customer";
             underpaid: "underpaid";
         }>>;
@@ -1369,8 +1369,8 @@ export declare const paymentIntentRoutes: readonly [{
         cancellation_reason: z.ZodNullable<z.ZodEnum<{
             duplicate: "duplicate";
             fraudulent: "fraudulent";
-            automatic: "automatic";
             abandoned: "abandoned";
+            automatic: "automatic";
             requested_by_customer: "requested_by_customer";
             underpaid: "underpaid";
         }>>;
@@ -1530,8 +1530,8 @@ export declare const paymentIntentRoutes: readonly [{
         cancellation_reason: z.ZodNullable<z.ZodEnum<{
             duplicate: "duplicate";
             fraudulent: "fraudulent";
-            automatic: "automatic";
             abandoned: "abandoned";
+            automatic: "automatic";
             requested_by_customer: "requested_by_customer";
             underpaid: "underpaid";
         }>>;
@@ -1696,8 +1696,8 @@ export declare const paymentIntentRoutes: readonly [{
         cancellation_reason: z.ZodNullable<z.ZodEnum<{
             duplicate: "duplicate";
             fraudulent: "fraudulent";
-            automatic: "automatic";
             abandoned: "abandoned";
+            automatic: "automatic";
             requested_by_customer: "requested_by_customer";
             underpaid: "underpaid";
         }>>;
@@ -1855,8 +1855,8 @@ export declare const paymentIntentRoutes: readonly [{
         cancellation_reason: z.ZodNullable<z.ZodEnum<{
             duplicate: "duplicate";
             fraudulent: "fraudulent";
-            automatic: "automatic";
             abandoned: "abandoned";
+            automatic: "automatic";
             requested_by_customer: "requested_by_customer";
             underpaid: "underpaid";
         }>>;
@@ -2014,8 +2014,8 @@ export declare const paymentIntentRoutes: readonly [{
             cancellation_reason: z.ZodNullable<z.ZodEnum<{
                 duplicate: "duplicate";
                 fraudulent: "fraudulent";
-                automatic: "automatic";
                 abandoned: "abandoned";
+                automatic: "automatic";
                 requested_by_customer: "requested_by_customer";
                 underpaid: "underpaid";
             }>>;

package/dist/types/resources/payments/refunds.d.ts

@@ -1,7 +1,8 @@
 import { z } from 'zod';
 import { type Expand } from '../../common/objects';
 /**
- * Refunds (`re_…`) and a payment's settlement figures. The provider's own
+ * Refunds (`re_…`) and the settlement figures of a payment, a refund or a
+ * dispute. The provider's own
  * refund id never appears: a merchant integrates against Peable and never
  * learns which acquirer sat behind it (ADR 0001 D3).
  */
@@ -49,15 +50,28 @@ export declare const refundSchema: z.ZodObject<{
 }, z.core.$strict>;
 export type Refund = Expand<z.output<typeof refundSchema>>;
 /**
- * What a payment actually came to, as the PROVIDER reports it. Every figure is
- * nullable and that is the contract: "the fee was zero" and "the fee is not
- * known yet" are different facts, and `status` says which produced the nulls.
- * It reports what the provider took; it attributes that cost to nobody.
+ * One movement of the settlement balance, as the PROVIDER reports it: what a
+ * payment brought in (`GET /v1/payment_intents/{intentId}/settlement`), what a
+ * refund took out (`GET /v1/refunds/{id}/settlement`) or what a dispute
+ * withdrew (`GET /v1/disputes/{disputeId}/settlement`). `refund` and `dispute`
+ * say which: both `null` for a payment's.
+ *
+ * Every figure is nullable and that is the contract: "the fee was zero" and
+ * "the fee is not known yet" are different facts, and `status` says which
+ * produced the nulls. It reports what the provider took; it attributes that
+ * cost to nobody.
+ *
+ * The signs: `gross` is the MAGNITUDE of the movement, `fee` the provider's fee
+ * on it (positive when charged, negative when returned), `net` its SIGNED
+ * effect on the balance — so `net = gross − fee` for a payment and
+ * `net = −gross − fee` for a refund or a dispute.
  */
 export declare const settlementSchema: z.ZodObject<{
     object: z.ZodLiteral<"settlement">;
     livemode: z.ZodBoolean;
     payment_intent: z.ZodType<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">, z.core.$ZodTypeInternals<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">>>;
+    refund: z.ZodNullable<z.ZodType<string | import("../..").Ref<"refund">, string | import("../..").Ref<"refund">, z.core.$ZodTypeInternals<string | import("../..").Ref<"refund">, string | import("../..").Ref<"refund">>>>;
+    dispute: z.ZodNullable<z.ZodType<string | import("../..").Ref<"dispute">, string | import("../..").Ref<"dispute">, z.core.$ZodTypeInternals<string | import("../..").Ref<"dispute">, string | import("../..").Ref<"dispute">>>>;
     status: z.ZodEnum<{
         unknown: "unknown";
         pending: "pending";
@@ -601,6 +615,8 @@ export declare const refundRoutes: readonly [{
         object: z.ZodLiteral<"settlement">;
         livemode: z.ZodBoolean;
         payment_intent: z.ZodType<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">, z.core.$ZodTypeInternals<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">>>;
+        refund: z.ZodNullable<z.ZodType<string | import("../..").Ref<"refund">, string | import("../..").Ref<"refund">, z.core.$ZodTypeInternals<string | import("../..").Ref<"refund">, string | import("../..").Ref<"refund">>>>;
+        dispute: z.ZodNullable<z.ZodType<string | import("../..").Ref<"dispute">, string | import("../..").Ref<"dispute">, z.core.$ZodTypeInternals<string | import("../..").Ref<"dispute">, string | import("../..").Ref<"dispute">>>>;
         status: z.ZodEnum<{
             unknown: "unknown";
             pending: "pending";
@@ -615,6 +631,41 @@ export declare const refundRoutes: readonly [{
     }, z.core.$strict>;
     readonly sdk: "refunds.settlement";
     readonly expandable: "settlement";
+}, {
+    readonly operationId: "retrieveRefundSettlement";
+    readonly method: "get";
+    readonly path: "/v1/refunds/{id}/settlement";
+    readonly tag: "Refunds";
+    readonly summary: "Retrieve a refund's settlement";
+    readonly description: "What the refund took off the settlement balance — `gross`, `fee`, a negative `net` — in the settlement currency, read live from the provider. A missing figure is `null` with a `status`, never `0`; a refund that failed or was canceled is `unknown`.";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly params: {
+        id: string;
+    };
+    readonly query: z.ZodObject<{
+        expand: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>, z.ZodTransform<string[], string | string[]>>, z.ZodArray<z.ZodString>>>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        object: z.ZodLiteral<"settlement">;
+        livemode: z.ZodBoolean;
+        payment_intent: z.ZodType<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">, z.core.$ZodTypeInternals<string | import("../..").Ref<"payment_intent">, string | import("../..").Ref<"payment_intent">>>;
+        refund: z.ZodNullable<z.ZodType<string | import("../..").Ref<"refund">, string | import("../..").Ref<"refund">, z.core.$ZodTypeInternals<string | import("../..").Ref<"refund">, string | import("../..").Ref<"refund">>>>;
+        dispute: z.ZodNullable<z.ZodType<string | import("../..").Ref<"dispute">, string | import("../..").Ref<"dispute">, z.core.$ZodTypeInternals<string | import("../..").Ref<"dispute">, string | import("../..").Ref<"dispute">>>>;
+        status: z.ZodEnum<{
+            unknown: "unknown";
+            pending: "pending";
+            available: "available";
+        }>;
+        gross: z.ZodNullable<z.ZodString>;
+        fee: z.ZodNullable<z.ZodString>;
+        net: z.ZodNullable<z.ZodString>;
+        currency: z.ZodNullable<z.ZodString>;
+        available_on: z.ZodNullable<z.ZodNumber>;
+        exchange_rate: z.ZodNullable<z.ZodNumber>;
+    }, z.core.$strict>;
+    readonly sdk: "refunds.refundSettlement";
+    readonly expandable: "settlement";
 }, {
     readonly operationId: "searchRefunds";
     readonly method: "get";

package/dist/types/resources/payments/testHelpers.d.ts

@@ -118,8 +118,8 @@ export declare const paymentIntentTestHelperRoutes: readonly [{
         cancellation_reason: z.ZodNullable<z.ZodEnum<{
             duplicate: "duplicate";
             fraudulent: "fraudulent";
-            automatic: "automatic";
             abandoned: "abandoned";
+            automatic: "automatic";
             requested_by_customer: "requested_by_customer";
             underpaid: "underpaid";
         }>>;

package/dist/types/resources/tax/index.d.ts

@@ -108,9 +108,9 @@ export declare const taxRoutes: readonly [{
             expires_at: import("zod").ZodNullable<import("zod").ZodNumber>;
             status: import("zod").ZodEnum<{
                 active: "active";
-                expired: "expired";
                 pending_approval: "pending_approval";
                 scheduled: "scheduled";
+                expired: "expired";
             }>;
             approved_at: import("zod").ZodNullable<import("zod").ZodNumber>;
             provider_registration_ref: import("zod").ZodNullable<import("zod").ZodString>;

package/dist/types/resources/tax/registrations.d.ts

@@ -23,9 +23,9 @@ export declare const taxRegistrationSchema: z.ZodObject<{
     expires_at: z.ZodNullable<z.ZodNumber>;
     status: z.ZodEnum<{
         active: "active";
-        expired: "expired";
         pending_approval: "pending_approval";
         scheduled: "scheduled";
+        expired: "expired";
     }>;
     approved_at: z.ZodNullable<z.ZodNumber>;
     provider_registration_ref: z.ZodNullable<z.ZodString>;
@@ -88,9 +88,9 @@ export declare const taxRegistrationRoutes: readonly [{
             expires_at: z.ZodNullable<z.ZodNumber>;
             status: z.ZodEnum<{
                 active: "active";
-                expired: "expired";
                 pending_approval: "pending_approval";
                 scheduled: "scheduled";
+                expired: "expired";
             }>;
             approved_at: z.ZodNullable<z.ZodNumber>;
             provider_registration_ref: z.ZodNullable<z.ZodString>;

package/dist/types/vocabulary/catalog.d.ts

@@ -86,12 +86,3 @@ export declare const METER_AGGREGATIONS: readonly ["sum", "count", "last"];
 export type MeterAggregation = (typeof METER_AGGREGATIONS)[number];
 export declare const METER_STATUSES: readonly ["active", "inactive"];
 export type MeterStatus = (typeof METER_STATUSES)[number];
-/** A provider subscription's status, as the recurring transport observes it. */
-export declare const BILLING_SUBSCRIPTION_STATUSES: readonly ["incomplete", "incomplete_expired", "trialing", "active", "past_due", "canceled", "unpaid", "paused"];
-export type BillingSubscriptionStatus = (typeof BILLING_SUBSCRIPTION_STATUSES)[number];
-/** `fiat` (Stripe and any further provider) or `faircoin` (native, to the merchant's watch-only wallet). */
-export declare const BILLING_RAIL_SETTLEMENTS: readonly ["fiat", "faircoin"];
-export type BillingRailSettlement = (typeof BILLING_RAIL_SETTLEMENTS)[number];
-/** `automatic`: the provider charges each period. `payer_initiated`: each period is an explicit payment. */
-export declare const BILLING_RAIL_RENEWALS: readonly ["automatic", "payer_initiated"];
-export type BillingRailRenewal = (typeof BILLING_RAIL_RENEWALS)[number];

package/dist/types/vocabulary/errors.d.ts

@@ -21,19 +21,15 @@ export declare const ERROR_CODE_DESCRIPTIONS: {
     readonly account_invalid: "The `Peable-Account` header names no connected account of this platform.";
     readonly account_missing: "The merchant has no account object yet.";
     readonly amount_not_representable: "The amount does not fit the currency or the rail.";
-    readonly billing_not_enabled: "Billing is not enabled for this merchant.";
-    readonly billing_provider_unavailable: "The billing provider could not be reached; retry.";
     readonly domain_taken: "The domain is already registered by another merchant.";
     readonly file_too_large: "The uploaded file is larger than its purpose allows.";
     readonly file_unavailable: "The file exists but its contents cannot be served right now.";
     readonly idempotency_error: "The `Idempotency-Key` was used with a different request, or its first request is still running.";
     readonly idempotency_key_invalid: "The `Idempotency-Key` header is not a valid key.";
     readonly insufficient_scope: "The credential is valid but was not granted the Oxy scope this route requires (`payments:read`, `payments:write`, …); `message` names it.";
-    readonly invalid_billing_request: "The billing request is not valid for this subscription or offer.";
     readonly keyless_recipient: "The recipient has no receive key, so no address can be derived for them.";
     readonly link_not_found: "The link does not exist or is no longer active.";
     readonly live_payments_gated: "Live payments are not enabled for this application yet.";
-    readonly local_test_request_required: "This test helper only answers a local test request.";
     readonly parameter_invalid: "A parameter is invalid; `param` names it.";
     readonly parameter_missing: "A required parameter is missing; `param` names it.";
     readonly parameter_unknown: "The request carries a parameter this route does not accept; `param` names it.";
@@ -62,10 +58,7 @@ export declare const ERROR_CODE_DESCRIPTIONS: {
     readonly customer_location_invalid: "The tax provider could not use the customer's location.";
     readonly dispute_already_submitted: "Evidence for this dispute has already been submitted; it is one shot.";
     readonly dispute_not_answerable: "The dispute is in a status that no longer accepts evidence.";
-    readonly idempotency_conflict: "The same operation key was used for a different billing request.";
-    readonly identity_conflict: "The billing identity already belongs to another customer or subscription.";
     readonly in_progress: "The same operation is still running; retry with the same key.";
-    readonly invalid_provider_response: "The provider answered with something Peable cannot trust; the operation was not applied.";
     readonly invalid_registration: "The tax registration is not valid.";
     readonly invalid_registration_declaration: "The tax registration declaration is not valid.";
     readonly invalid_tax_code: "The tax code does not exist.";
@@ -80,12 +73,9 @@ export declare const ERROR_CODE_DESCRIPTIONS: {
     readonly product_in_use: "The product is referenced by a subscription or a link.";
     readonly promotion_code_invalid: "The promotion code does not exist, is inactive or does not apply.";
     readonly promotion_code_taken: "Another active promotion code already uses this `code`.";
-    readonly provider_unavailable: "The payment provider could not be reached; retry.";
     readonly rail_unavailable: "The payment rail this request needs is not available.";
-    readonly reconciliation_required: "The billing operation has an unknown outcome at the provider and is being reconciled.";
     readonly registration_immutable: "An approved or ended tax registration cannot be deleted or changed this way; end it instead.";
     readonly resource_already_exists: "An object with this identity already exists.";
-    readonly result_expired: "The stored result of this operation has expired.";
     readonly review_item_not_open: "The review item is already resolved or dismissed.";
     readonly rule_set_version_unavailable: "The tax rule set version is not available.";
     readonly subscription_line_invalid: "A subscription line item is not valid for Checkout.";
@@ -93,9 +83,6 @@ export declare const ERROR_CODE_DESCRIPTIONS: {
     readonly tax_calculation_unavailable: "Tax could not be calculated; a covered sale fails closed.";
     readonly tax_provider_registration_mismatch: "The provider's registrations disagree with the ones Peable has approved.";
     readonly tax_settings_not_active: "Tax settings are not active for this merchant.";
-    readonly local_test_unavailable: "The local test checkout is not available.";
-    readonly local_test_configuration_unavailable: "The local test checkout has no provider configuration.";
-    readonly local_test_subscription_unavailable: "The local test subscription cannot be read.";
     readonly rail_mismatch: "The operation does not apply to the rail this payment uses.";
     readonly checkout_session_changed: "The Checkout Session changed while this request ran (a price, a discount, its tax); read it again and retry.";
     readonly checkout_session_locked: "The Checkout Session is being confirmed and cannot change.";

package/dist/types/vocabulary/events.d.ts

@@ -54,7 +54,6 @@ export declare const WEBHOOK_EVENT_OBJECTS: {
     readonly 'setup_intent.succeeded': "setup_intent";
     readonly 'setup_intent.setup_failed': "setup_intent";
     readonly 'setup_intent.canceled': "setup_intent";
-    readonly 'billing.observation.updated': "billing_observation";
     readonly 'connected_account.updated': "connected_account";
     readonly 'product.created': "product";
     readonly 'product.updated': "product";
@@ -147,8 +146,12 @@ export type WebhookEndpointStatus = (typeof WEBHOOK_ENDPOINT_STATUSES)[number];
  *  - `delivery_failures`    — every delivery to it failed for three days
  *    straight, so Peable stopped sending. Re-enabling it (`disabled: false`)
  *    starts the clock again.
+ *  - `url_refused`          — its stored `url` breaks the rules a URL is
+ *    registered under (https in live mode, ports 80/443, no private, loopback
+ *    or reserved address), judged again before every delivery, so Peable never
+ *    sent to it. It is re-enabled only together with a `url` that passes.
  */
-export declare const WEBHOOK_ENDPOINT_DISABLED_REASONS: readonly ["disabled_by_merchant", "delivery_failures"];
+export declare const WEBHOOK_ENDPOINT_DISABLED_REASONS: readonly ["disabled_by_merchant", "delivery_failures", "url_refused"];
 export type WebhookEndpointDisabledReason = (typeof WEBHOOK_ENDPOINT_DISABLED_REASONS)[number];
 /** At most this many endpoints per merchant (per mode). */
 export declare const WEBHOOK_ENDPOINTS_MAX_PER_MERCHANT = 16;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peable.to/contracts",
-  "version": "2.0.0",
+  "version": "3.1.0",
   "description": "The Peable wire, declared once: Zod contracts of every public route, the OpenAPI 3.1 generator and the closed value sets (ADR 0014 D5).",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",