SCscanopy
internal

Resume paused subscription

Changed on

Clears Stripe pause collection and re-activates billing. Available while plan_status === 'paused'. The prorated pause credit is posted to the customer's Stripe balance asynchronously by the webhook arm that fires for the pause_collection clear — the endpoint just returns success.

post/api/billing/resume

Request

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

Response

Subscription resumed

datastring

The result payload. Omitted on failure.

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

  • 94d0a78653e1Revision changes
    • breaking

      the response's property type changed from object to string for status

    • breaking

      removed the required property / from the response with the status

    • warning

      removed the optional property / from the response with the status