Preview ILS refund

Changed on

<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. 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 for the multiplier your plan gets.

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

Response

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

eligibleboolean required

true when cancelling now refunds part of this period. When false, no other field is returned.

tierstring nullable

Plan the refund is calculated for, as a plan key that can carry a currency suffix.

intervalstring nullable

Billing period of the plan: monthly or yearly.

currencystring nullable

Lowercase three-letter currency code of the amounts.

refund_agorotinteger 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_agorotinteger 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_usedinteger nullable

Yearly plans: days of the period already used. 0 for monthly plans and for workspaces billed through Wix.

remaining_daysinteger nullable

Monthly plans: days left in the period. 0 for yearly plans and for workspaces billed through Wix.

total_daysinteger 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_cancelboolean nullable

Always true when eligible: taking the refund cancels the subscription right away.

Example response

{
  "eligible": true,
  "tier": "builder_ils",
  "interval": "monthly",
  "currency": "ils",
  "refund_agorot": 4275,
  "amount_paid_agorot": 9000,
  "remaining_days": 15,
  "total_days": 30,
  "is_immediate_cancel": true
}

Changes