Plans and entitlements

See the plans available to you, what each one includes, and assign them to your accounts.

See the plans available to you, what each one includes, and assign them to your accounts.

Shout About Us configures plans. Partners assign them.

A plan is more than a price. It defines what a location gets: which review sites it's connected to, how often reviews are collected from each, which capabilities are switched on (responses, AI drafts, flagging, review requests, reports, and so on) with their limits, and what it costs. Assign a plan to an account and every location under it inherits all of that automatically.

You can't create or edit plans through the API or the dashboard. Your account team builds them for you. What you can do here is list the plans you have, see exactly what's in each one, assign one to an account, change it, and cancel it.

Two ways a plan can be priced. Some plans bundle everything into a per-location monthly price with allowances per capability and either a hard stop or an overage rate when an allowance is used up. Others meter each capability against a rate card, so you pay for what your locations actually use. Your plans are one or the other; this page and each plan's details tell you which.

You'll need the account's id (or your client_account_id) to assign a plan, and the plan_id, which comes from List your plans.

Prerequisites

  • A bearer token in the Authorization header. Any endpoint that needs no token says so on its own page.
  • The id of each record the call targets. Every endpoint page lists the ids it needs.

Errors

StatusMeaning
401The bearer token is missing, expired or invalid
403The token is valid but the record sits outside your account
422The request failed validation — the response names the fields
500Unexpected server error

Individual endpoints may return more; each page lists its own.

Endpoints

List your plans

GET — Get every plan available to your partner.

Open →

Get one plan

GET — Get the full definition of a single plan.

Open →

Get your billing setup

GET — See how your partner is billed: bundled or metered, the contract model, and the rates that apply.

Open →

Assign or change an account's plan

POST — Put an account on a plan, or move it to a different one.

Open →

Get a location's current plan

GET — See the plan a specific location is on right now, and who pays for it.

Open →

List plans visible to an account

GET — Get the plans an account can see, for display in an account-facing UI.

Open →

Add locations to a plan mid-cycle

POST — Put one or more locations on a plan partway through a billing period, charged pro rata for the remainder.

Open →

Cancel a plan

POST — End the plan for an account (every location) or for selected locations.

Open →

Cancel a plan (selected locations)

POST — End the plan for selected locations under an account, leaving the rest running.

Open →


Did this page help you?