> ## Documentation Index
> Fetch the complete documentation index at: https://docs.base44.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Preview ILS refund
> This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.
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.
## OpenAPI
````yaml /developers/references/app-management/app-management-openapi.json get /api/billing/ils-refund-preview
openapi: 3.1.0
info:
title: Base44 App Management API
version: 1.0.0
servers:
- url: https://app.base44.com
security:
- PersonalAccessTokenAuth: []
paths:
/api/billing/ils-refund-preview:
get:
summary: Preview ILS refund
description: >-
This API is in beta. Endpoints, fields, and behavior may still
change, so avoid depending on it in production.
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.
operationId: ils_refund_preview_api_billing_ils_refund_preview_get
responses:
'200':
description: Whether cancelling now refunds part of the period, and how much.
content:
application/json:
schema:
$ref: '#/components/schemas/IlsRefundPreview'
example:
eligible: true
tier: builder_ils
interval: monthly
currency: ils
refund_agorot: 4275
amount_paid_agorot: 9000
days_used: 0
remaining_days: 15
total_days: 30
is_immediate_cancel: true
'400':
description: The refund couldn't be worked out right now. Retry later.
'401':
description: >-
Missing or invalid credentials. A read-only token gets this response
too.
'403':
description: You aren't the workspace owner.
'429':
description: >-
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.
security:
- PersonalAccessTokenAuth:
- full_access
components:
schemas:
IlsRefundPreview:
properties:
eligible:
type: boolean
title: Eligible
description: >-
`true` when cancelling now refunds part of this period. When
`false`, no other field is returned.
example: true
tier:
anyOf:
- type: string
- type: 'null'
title: Tier
description: >-
Plan the refund is calculated for, as a plan key that can carry a
currency suffix.
example: builder_ils
interval:
anyOf:
- type: string
- type: 'null'
title: Interval
description: 'Billing period of the plan: `monthly` or `yearly`.'
example: monthly
currency:
anyOf:
- type: string
- type: 'null'
title: Currency
description: Lowercase three-letter currency code of the amounts.
example: ils
refund_agorot:
anyOf:
- type: integer
- type: 'null'
title: Refund Agorot
description: >-
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.
example: 4275
amount_paid_agorot:
anyOf:
- type: integer
- type: 'null'
title: Amount Paid Agorot
description: >-
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.
example: 9000
days_used:
anyOf:
- type: integer
- type: 'null'
title: Days Used
description: >-
Yearly plans: days of the period already used. `0` for monthly plans
and for workspaces billed through Wix.
example: 0
remaining_days:
anyOf:
- type: integer
- type: 'null'
title: Remaining Days
description: >-
Monthly plans: days left in the period. `0` for yearly plans and for
workspaces billed through Wix.
example: 15
total_days:
anyOf:
- type: integer
- type: 'null'
title: Total Days
description: >-
Length of the period in days: the month's length for monthly plans,
or 365 for yearly plans. `0` for workspaces billed through Wix.
example: 30
is_immediate_cancel:
anyOf:
- type: boolean
- type: 'null'
title: Is Immediate Cancel
description: >-
Always `true` when eligible: taking the refund cancels the
subscription right away.
example: true
type: object
required:
- eligible
title: IlsRefundPreview
description: >-
The refund an immediate cancellation pays under Israeli
consumer-protection rules.
securitySchemes:
PersonalAccessTokenAuth:
type: http
scheme: bearer
description: >-
Personal access token, sent as `Authorization: Bearer `. Each
operation lists the permission it needs: `read_only` or `full_access`. A
full-access token can call every operation. A read-only token can call
only the operations that list `read_only`; anything else returns 403
`read_only_credential_route_not_allowed`.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.