SCscanopy
internal

Read live terms for the configured save-offer coupon

Changed on

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.

get/api/billing/save-offer-coupon

Request

  • Base URL
    https://app.scanopy.net
  • URL
    https://app.scanopy.net/api/billing/save-offer-coupon
  • Auth
    • API key in header Authorization
    • or API key in cookie session_id

Response

Save-offer coupon terms, or null when not configured

errorstring nullable

Not sent on a successful response. Failure messages arrive in an ApiErrorResponse.

successboolean required

Always true on a successful response.

Example response

{
  "meta": {
    "api_version": 1,
    "server_version": "0.19.4"
  }
}

Changes

  • c9d9d46d1ae8Revision changes
    • info

      api tag billing removed

  • 4169a28d0625Revision changes
    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status