Skip to main content
GET
Preview ILS refund

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>. 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.

Response

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

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.

Example:

true

tier
string | null

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

Example:

"builder_ils"

interval
string | null

Billing period of the plan: monthly or yearly.

Example:

"monthly"

currency
string | null

Lowercase three-letter currency code of the amounts.

Example:

"ils"

refund_agorot
integer | null

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
integer | null

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
integer | null

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

Example:

0

remaining_days
integer | null

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

Example:

15

total_days
integer | null

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
boolean | null

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

Example:

true