---
title: "Preview ILS refund"
method: GET
path: "/api/billing/ils-refund-preview"
---

# Preview ILS refund

`GET /api/billing/ils-refund-preview`

## Request

- Base URL: `https://app.base44.com`
- URL: `https://app.base44.com/api/billing/ils-refund-preview`
- Auth: HTTP bearer

<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Shows whether cancelling your workspace's subscription now refunds part of the current period under Israeli consumer-protection rules, and how much. Nothing changes.

The refund applies to plans billed in shekels, and to customers in Israel on the same plans in another currency. To take it, send `ils_refund_consent: true` to [Cancel subscription](/api-reference/cancel-subscription). That cancels the subscription right away instead of at the end of the period.

When `eligible` is `false`, the response has no other fields. Only the workspace owner can call this.

The base rate limit is 20 requests per hour per user. See [Rate limits](/developers/references/apps-api/get-started/rate-limits) for the multiplier your plan gets.

## Response `200`

Whether cancelling now refunds part of the period, and how much.

- IlsRefundPreview: The refund an immediate cancellation pays under Israeli consumer-protection rules.
  - `eligible` boolean, required: `true` when cancelling now refunds part of this period. When `false`, no other field is returned.
  - `tier` string, nullable: Plan the refund is calculated for, as a plan key that can carry a currency suffix.
  - `interval` string, nullable: Billing period of the plan: `monthly` or `yearly`.
  - `currency` string, nullable: Lowercase three-letter currency code of the amounts.
  - `refund_agorot` integer, nullable: Refund you get if you cancel now, in the smallest unit of `currency` (agorot for ILS, cents for USD). Can be `0` when nothing is left to refund.
  - `amount_paid_agorot` integer, nullable: What was paid for the current period, in the smallest unit of `currency`. `0` when the workspace is billed through Wix, which reports only the refund.
  - `days_used` integer, nullable: Yearly plans: days of the period already used. `0` for monthly plans and for workspaces billed through Wix.
  - `remaining_days` integer, nullable: Monthly plans: days left in the period. `0` for yearly plans and for workspaces billed through Wix.
  - `total_days` integer, nullable: Length of the period in days: the month's length for monthly plans, or 365 for yearly plans. `0` for workspaces billed through Wix.
  - `is_immediate_cancel` boolean, nullable: Always `true` when eligible: taking the refund cancels the subscription right away.

## Other responses

- `400`: The refund couldn't be worked out right now. Retry later.
- `401`: Missing or invalid credentials. A read-only token gets this response too.
- `403`: You aren't the workspace owner.
- `429`: Rate limit exceeded. The base rate limit is 20 requests per hour per user. See [Rate limits](/developers/references/apps-api/get-started/rate-limits) for the multiplier your plan gets.

## Changes

> 66 revisions in range; 1 not diffed.

- **2026-10-26** `395a6758864a`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/adexad/apis/base44-app-management-api/changes/api/billing/ils-refund-preview/get.md)

---

[API](https://skmtc.dev/adexad/apis/base44-app-management-api.md) - [All operations](https://skmtc.dev/adexad/apis/base44-app-management-api/llms.txt) - [OpenAPI document](https://skmtc.dev/adexad/apis/base44-app-management-api/revisions/d877a932dc19?raw)
