---
title: "Read live terms for the configured save-offer coupon"
method: GET
path: "/api/billing/save-offer-coupon"
tags: ["billing", "internal"]
---

# Read live terms for the configured save-offer coupon

`GET /api/billing/save-offer-coupon`

Returns the coupon's `percent_off` and `duration_in_months` so the
cancel modal's Discount panel can render the offer dynamically. The
payload is `null` when `STRIPE_SAVE_OFFER_COUPON_ID` is unset — the
modal hides the panel in that case.

## Response `200`

Save-offer coupon terms, or null when not configured

- ApiResponseOptionSaveOfferCoupon
  - `data` object, nullable — Live terms for the configured save-offer coupon, read directly from Stripe. Used by the cancel modal's Discount panel to render the offer dynamically instead of hard-coding the percent/duration. Only returned when the coupon would actually catch the user's next invoice — i.e. `next_renewal_at` falls within the coupon's `duration_in_months` window. Yearly subscribers partway through a cycle whose next renewal lands after the coupon's window get `None` from the endpoint and the cancel modal's Discount panel doesn't render. `billing_rate` lets the frontend pick monthly vs yearly copy: a monthly subscriber thinks in terms of "N months of discount"; a yearly subscriber thinks in terms of "my next renewal on {date}."
    - `billing_rate` 'Month' | 'Year', required
    - `duration_in_months` integer, required — How many months the discount lasts.
    - `next_renewal_at` string, date-time, required — When the discounted subscription next renews.
    - `percent_off` integer, required — Discount applied by the retention offer.
  - `error` string, nullable — Human-readable failure message. Omitted on success.
  - `meta` ApiMeta, required — API metadata included in all responses
    - `api_version` integer, required — API version (integer, increments on breaking changes)
    - `server_version` string, required — Server version (semver)
  - `success` boolean, required — `true` when the request succeeded. `false` responses carry `error` instead of `data`.

## Other responses

- `400` — Billing not enabled

---

[API](https://skmtc.net/scanopy/apis/scanopy-api.md) · [All operations](https://skmtc.net/scanopy/apis/scanopy-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/scanopy/scanopy-api/revisions/2df1fc47dfa7/schema)