Cancel a plan

Overview

End the plan for every location in an account. To cancel only some locations, use Cancel a plan (selected locations).

You'll need the account's company_id and a cancelling_reason.

The plans close immediately (plan_end is set to now), so review collection and posting stop straight away. Your account team is notified.

Prerequisites

• A Partner or Account token. See Authentication.
• The account's id (company_id).

Base URL

Endpoint

POST /api/v1/plans/cancel-account-subscription

Authentication

Partner or Account token

• company_id must be an existing account inside your own account tree; otherwise 422.
• The caller must be the account itself or its direct parent. An Account token cancels its own account; the partner directly above an account can cancel it. A partner higher up the tree gets 403.

Rate limit

This endpoint has no rate limit.

Request parameters

None.

Request body

Request payload

{
  "company_id": 5994,
  "cancelling_reason": "Price too high",
  "cancelling_reason_other": "Switching to a competitor"
}

Response body

The payload is inside data.

Response payload

{
  "data": {
    "message": "Subscription cancelled successfully."
  }
}

Examples

Success payload

See Response payload.

Error payload

403 Permission denied

You aren't the account or its direct parent.

{
  "message": "Forbidden",
  "status": "error",
  "errors": "Permission denied"
}

404 Location not found

The account has no active or pending locations.

{
  "message": "Not Found",
  "status": "error",
  "errors": "Location not found."
}

404 No active plan found

None of the account's locations is paid for by the account or the partner.

{
  "message": "Not Found",
  "status": "error",
  "errors": "No active plan found."
}

422 Invalid account or reason

{
  "message": "The selected company id is invalid. (and 2 more errors)",
  "errors": {
    "company_id": [
      "The selected company id is invalid.",
      "The selected company id does not belong to your company hierarchy."
    ],
    "cancelling_reason": ["The selected cancelling reason is invalid."]
  }
}

Example request

curl --request POST \
  --url "https://production-api.shoutaboutus.com/api/v1/plans/cancel-account-subscription" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"company_id": 5994, "cancelling_reason": "Price too high", "cancelling_reason_other": "Switching to a competitor"}'