@delopay/sdk 0.102.0 → 0.103.0

package/dist/index.cjs

@@ -3910,6 +3910,46 @@ var Settlement = class {
       ...options
     });
   }
+  /**
+   * What a period's payments cost, and what was left over: gross, the
+   * platform fee, hosting fees, what the rails took, and the margin, with a
+   * per-connector breakdown.
+   *
+   * Send `year` and `month` together to report one UTC calendar month, or
+   * neither for the running month so far.
+   *
+   * **Host-only.** The response is the host's cost base, which a shop owner
+   * must never see, so a profile-scoped caller is refused with a 403 rather
+   * than given a redacted shell. Gate the surface on the caller's scope
+   * instead of calling it and handling the failure.
+   *
+   * Two things not to flatten when rendering the result:
+   * `margin_usd` is absent — not zero — whenever `margin_quality` is
+   * `'unknown'`, and `unlined_captured_attempt_count` (cost definitely
+   * missing) means something different from `unlined_unresolved_attempt_count`
+   * (mostly ordinary abandonment).
+   *
+   * `GET /settlement/cost`
+   *
+   * @example
+   * ```typescript
+   * const cost = await delopay.settlement.cost({ test_mode: false, year: 2026, month: 7 });
+   * if (cost.margin_quality === 'unknown') {
+   *   // cost.margin_usd is absent — say so, do not render 0.00
+   * }
+   * ```
+   */
+  async cost(params, options) {
+    return this.request("GET", "/settlement/cost", {
+      query: {
+        profile_id: params?.profile_id,
+        test_mode: params?.test_mode,
+        year: params?.year,
+        month: params?.month
+      },
+      ...options
+    });
+  }
   /**
    * List generated settlement statements, newest first.
    *