SCscanopy
internal

Preview plan change (shows overage counts)

Changed on
get/api/billing/change-plan/preview

Request

  • Base URL
    https://app.scanopy.net
  • URL
    https://app.scanopy.net/api/billing/change-plan/preview
  • Auth
    • API key in header Authorization
    • or API key in cookie session_id

Query parameters

planstring required

Target plan (JSON)

Response

Plan change preview

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

  • a6ea2ab6fbb9Revision changes
    • breaking

      removed the required property / from the response with the status

    • info

      added the required property / to the response with the status