Skip to content

docs: document the prorated refund preference - #501

Merged
eandreeva-twr merged 2 commits into
mainfrom
docs/refund-saver-grant-prorated
Aug 20, 2026
Merged

docs: document the prorated refund preference#501
eandreeva-twr merged 2 commits into
mainfrom
docs/refund-saver-grant-prorated

Conversation

@eandreeva-twr

Copy link
Copy Markdown
Collaborator

Refund Saver can now ask Apple to refund only the part of a purchase the user hasn't consumed yet, instead of the all-or-nothing choice between declining and granting.

Changes

refund-saver.mdx

  • New Grant prorated refund row in the default-preference table, in the position the option occupies in the Dashboard.
  • A paragraph on when to pick it — you keep the revenue for the consumed part instead of risking the whole payment on a decline.
  • New section on how the consumed share is determined: Apple calculates it for auto-renewable subscriptions; for every other product type Adapty calculates it, from the virtual currency the purchase granted or from the elapsed access period. A fully consumed purchase goes out as a decline, an untouched one as a full refund, and a purchase with no usage signal carries no preference at all.
  • Heading renamed from "Set a default refund behavior" to "Set a default refund preference". The Dashboard's Learn more link targets that anchor and currently lands on the page top; the rename fixes it. Nothing in the docs links to the old anchor.

adapty-api.yaml

  • grant_prorated added to the three custom_preference enums and to the request-schema description.

Zone brief (apple-platform)

  • Three dated notes: the Dashboard hard-codes docs anchors, so a heading rename in this area can break an in-product link that the link checker cannot see; the app-level and per-profile preferences are separate enums with different spellings; and no SDK exposes the prorated value.

Notes

The SDK snippets are deliberately untouched — every SDK still exposes only no_preference, grant, and decline, so the option reaches users through the Dashboard and the server-side API alone.

The Dashboard change adding this option had not shipped to production at the time of writing.

Verification

check-mdx-parse and lint-mdx pass, the spec parses with all three enums reading grant, grant_prorated, no_preference, decline, and check-links-diff reports 0 broken and 0 stale links.

Refund Saver can now ask Apple to refund only the unconsumed part of a
purchase. Adds the option to the default-preference table, explains how
the consumed share is determined per product type, and adds the value to
the server-side API spec.

Renames the "Set a default refund behavior" heading to "Set a default
refund preference" so the Dashboard's Learn more link resolves.
…nt-prorated

# Conflicts:
#	.claude/context-mill/docs-map.jsonl
@eandreeva-twr
eandreeva-twr merged commit 896cf71 into main Aug 20, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant