List partner plans
Overview
List the plans available to the authenticated partner. Usage-based partners get their partner-managed usage plans (editable); plan-based partners get the admin-managed plans assigned to them (read-only).
Prerequisites
- A bearer token. Callable with Partner tokens.
Base URL
| Environment | URL |
|---|---|
| Production | https://production-api.shoutaboutus.com |
| Development | https://development-api.shoutaboutus.com |
Endpoint
GET /api/v1/partner/plans/list
Authentication
- Requires a bearer token in the
Authorization: Bearer <bearer-token>header. - Who can call it: Partner tokens.
- Sits in the authenticated group, with no extra route-level guard.
getPartnerPlanListresolves the partner viagetAuthPartner(403 if none).- 403 (
Partner billing model is not configured.) unlessbilling_modelisusage-basedorplan-based. - Scoped to plans linked via
company_plans(non-deleted): usage-based, thenplan_type=usage-based AND is_admin_managed=0; plan-based, thenplan_type=plan-based AND is_admin_managed=1.
Rate limit
- No rate limit.
Request
— no path/query/body params.
Response
- Plan:
id, plan_name, price, original_price, status, plan_type, tier_slug, enforcement_mode, is_admin_managed, description, plan_end_date, short_info, … features[]—{ feature_name, enabled, service_limit, limit_type, included_units, overage_rate, hard_stop, partner_billing_enabled }plan_review_sites[]—{ review_site_id, pull_frequency, pull_interval, pull_times[], pull_days,review_site:{…} }meta—{ billing_model, read_only }(read_only=truefor plan-based partners or sub-partner callers)
200 — Usage-Based partner (editable) · 200
200{
"data": {
"data": [
{
"id": 8,
"plan_name": "Growth — Unlimited",
"price": 5,
"original_price": 6,
"status": "active",
"plan_type": "usage-based",
"tier_slug": null,
"enforcement_mode": "per-location",
"is_admin_managed": false,
"description": null,
"plan_end_date": null,
"short_info": null,
"created_at": "2026-06-19T06:21:21.000000Z",
"updated_at": "2026-06-19T06:21:21.000000Z",
"deleted_at": null,
"features": [
{
"id": 48,
"plan_id": 8,
"feature_name": "ai_response",
"enabled": true,
"service_limit": 12,
"limit_type": null,
"included_units": null,
"overage_rate": "0.0800",
"hard_stop": false,
"created_at": "2026-06-19T06:21:21.000000Z",
"updated_at": "2026-06-19T06:21:21.000000Z",
"deleted_at": null,
"partner_billing_enabled": true
},
{
"id": 49,
"plan_id": 8,
"feature_name": "review_flag",
"enabled": true,
"service_limit": 11,
"limit_type": null,
"included_units": null,
"overage_rate": "0.0800",
"hard_stop": false,
"created_at": "2026-06-19T06:21:21.000000Z",
"updated_at": "2026-06-19T06:21:21.000000Z",
"deleted_at": null,
"partner_billing_enabled": true
},
{
"id": 50,
"plan_id": 8,
"feature_name": "response_to_past_reviews",
"enabled": true,
"service_limit": null,
"limit_type": "monthly",
"included_units": 10,
"overage_rate": "0.0500",
"hard_stop": false,
"created_at": "2026-06-19T06:21:21.000000Z",
"updated_at": "2026-06-19T06:21:21.000000Z",
"deleted_at": null,
"partner_billing_enabled": true
},
{
"id": 51,
"plan_id": 8,
"feature_name": "response_posting",
"enabled": true,
"service_limit": 9,
"limit_type": null,
"included_units": null,
"overage_rate": "0.0400",
"hard_stop": false,
"created_at": "2026-06-19T06:21:21.000000Z",
"updated_at": "2026-06-19T06:21:21.000000Z",
"deleted_at": null,
"partner_billing_enabled": true
},
{
"id": 52,
"plan_id": 8,
"feature_name": "review_widgets",
"enabled": true,
"service_limit": 8,
"limit_type": null,
"included_units": null,
"overage_rate": "0.1000",
"hard_stop": false,
"created_at": "2026-06-19T06:21:21.000000Z",
"updated_at": "2026-06-19T06:21:21.000000Z",
"deleted_at": null,
"partner_billing_enabled": true
},
{
"id": 53,
"plan_id": 8,
"feature_name": "review_solicitation_email",
"enabled": true,
"service_limit": 7,
"limit_type": null,
"included_units": null,
"overage_rate": "0.0200",
"hard_stop": false,
"created_at": "2026-06-19T06:21:21.000000Z",
"updated_at": "2026-06-19T06:21:21.000000Z",
"deleted_at": null,
"partner_billing_enabled": true
},
{
"id": 54,
"plan_id": 8,
"feature_name": "review_solicitation_sms",
"enabled": true,
"service_limit": 6,
"limit_type": null,
"included_units": null,
"overage_rate": "0.0600",
"hard_stop": false,
"created_at": "2026-06-19T06:21:21.000000Z",
"updated_at": "2026-06-19T06:21:21.000000Z",
"deleted_at": null,
"partner_billing_enabled": true
},
{
"id": 55,
"plan_id": 8,
"feature_name": "insight_report",
"enabled": false,
"service_limit": null,
"limit_type": null,
"included_units": null,
"overage_rate": null,
"hard_stop": false,
"created_at": "2026-06-19T06:21:21.000000Z",
"updated_at": "2026-06-19T10:45:00.000000Z",
"deleted_at": null,
"partner_billing_enabled": false
},
{
"id": 56,
"plan_id": 8,
"feature_name": "competitive_analysis",
"enabled": false,
"service_limit": null,
"limit_type": null,
"included_units": null,
"overage_rate": null,
"hard_stop": false,
"created_at": "2026-06-19T06:21:21.000000Z",
"updated_at": "2026-06-19T10:45:00.000000Z",
"deleted_at": null,
"partner_billing_enabled": false
},
{
"id": 57,
"plan_id": 8,
"feature_name": "per_pull_data",
"enabled": true,
"service_limit": null,
"limit_type": null,
"included_units": null,
"overage_rate": null,
"hard_stop": false,
"created_at": "2026-06-19T06:21:21.000000Z",
"updated_at": "2026-06-19T06:21:21.000000Z",
"deleted_at": null,
"partner_billing_enabled": true
}
],
"plan_review_sites": [
{
"id": 12,
"plan_id": 8,
"review_site_id": 1,
"pull_frequency": "daily",
"pull_interval": 1,
"pull_times": [
"06:00"
],
"pull_days": [],
"created_at": "2026-06-19T06:21:21.000000Z",
"updated_at": "2026-06-19T06:21:21.000000Z",
"deleted_at": null,
"review_site": {
"id": 1,
"name": "Yelp",
"link": "http://www.yelp.com",
"review_site_button": "img-yelp.png",
"review_site_color": "#d32200",
"max_rate": 5,
"status": 0,
"show": true,
"use_sau_scrapper": "Y",
"publisher": "yelp.com",
"auth_type": "cookie",
"scraping_enabled": true,
"posting_enabled": true,
"self_form_enabled": "N",
"email_on_reply": "",
"deleted_at": null,
"created_at": "2015-05-26T09:18:10.000000Z",
"updated_at": "2020-05-04T02:44:57.000000Z"
}
},
{
"id": 13,
"plan_id": 8,
"review_site_id": 3,
"pull_frequency": "daily",
"pull_interval": 1,
"pull_times": [
"06:00"
],
"pull_days": [],
"created_at": "2026-06-19T06:21:21.000000Z",
"updated_at": "2026-06-19T06:21:21.000000Z",
"deleted_at": null,
"review_site": {
"id": 3,
"name": "Facebook",
"link": "http://www.facebook.com",
"review_site_button": "img-facebook.png",
"review_site_color": "#45619d",
"max_rate": 5,
"status": 0,
"show": true,
"use_sau_scrapper": "Y",
"publisher": "facebook.com",
"auth_type": "oauth",
"scraping_enabled": true,
"posting_enabled": true,
"self_form_enabled": "N",
"email_on_reply": "",
"deleted_at": null,
"created_at": "2015-05-26T09:18:10.000000Z",
"updated_at": "2020-05-04T02:44:57.000000Z"
}
},
{
"id": 14,
"plan_id": 8,
"review_site_id": 8,
"pull_frequency": "daily",
"pull_interval": 1,
"pull_times": [
"06:00"
],
"pull_days": [],
"created_at": "2026-06-19T06:21:21.000000Z",
"updated_at": "2026-06-19T06:21:21.000000Z",
"deleted_at": null,
"review_site": {
"id": 8,
"name": "Tripadvisor",
"link": "tripadvisor.com",
"review_site_button": "img-tripadvisor.png",
"review_site_color": "#00af87",
"max_rate": 5,
"status": 0,
"show": true,
"use_sau_scrapper": "Y",
"publisher": "tripadvisor.com",
"auth_type": "cookie",
"scraping_enabled": true,
"posting_enabled": true,
"self_form_enabled": "N",
"email_on_reply": "N",
"deleted_at": null,
"created_at": "2015-05-26T09:20:06.000000Z",
"updated_at": "2020-05-04T02:44:57.000000Z"
}
},
{
"id": 15,
"plan_id": 8,
"review_site_id": 16,
"pull_frequency": "daily",
"pull_interval": 1,
"pull_times": [
"06:00"
],
"pull_days": [],
"created_at": "2026-06-19T06:21:21.000000Z",
"updated_at": "2026-06-19T06:21:21.000000Z",
"deleted_at": null,
"review_site": {
"id": 16,
"name": "OpenTable",
"link": "opentable.com",
"review_site_button": "img-opentable.png",
"review_site_color": "#da3643",
"max_rate": 5,
"status": 0,
"show": true,
"use_sau_scrapper": "Y",
"publisher": "opentable.com",
"auth_type": "cookie",
"scraping_enabled": true,
"posting_enabled": true,
"self_form_enabled": "N",
"email_on_reply": "N",
"deleted_at": null,
"created_at": "2015-10-16T16:39:17.000000Z",
"updated_at": "2020-05-04T02:44:57.000000Z"
}
},
{
"id": 16,
"plan_id": 8,
"review_site_id": 44,
"pull_frequency": "daily",
"pull_interval": 1,
"pull_times": [
"06:00"
],
"pull_days": [],
"created_at": "2026-06-19T06:21:21.000000Z",
"updated_at": "2026-06-19T06:21:21.000000Z",
"deleted_at": null,
"review_site": {
"id": 44,
"name": "Google",
"link": "http://maps.google.com",
"review_site_button": "img-google.png",
"review_site_color": "#3774ee",
"max_rate": 5,
"status": 0,
"show": true,
"use_sau_scrapper": "Y",
"publisher": "maps.google.com",
"auth_type": "oauth",
"scraping_enabled": true,
"posting_enabled": true,
"self_form_enabled": "N",
"email_on_reply": "N",
"deleted_at": null,
"created_at": "2017-01-09T11:33:00.000000Z",
"updated_at": "2020-05-04T02:44:57.000000Z"
}
},
{
"id": 17,
"plan_id": 8,
"review_site_id": 54,
"pull_frequency": "daily",
"pull_interval": 1,
"pull_times": [
"06:00"
],
"pull_days": [],
"created_at": "2026-06-19T06:21:21.000000Z",
"updated_at": "2026-06-19T06:21:21.000000Z",
"deleted_at": null,
"review_site": {
"id": 54,
"name": "Apartments",
"link": "https://www.apartments.com/",
"review_site_button": "img-apartments.png",
"review_site_color": "#44e89f",
"max_rate": 5,
"status": 0,
"show": true,
"use_sau_scrapper": "Y",
"publisher": "apartments.com",
"auth_type": "cookie",
"scraping_enabled": true,
"posting_enabled": true,
"self_form_enabled": "N",
"email_on_reply": "N",
"deleted_at": null,
"created_at": "2019-05-03T10:50:48.000000Z",
"updated_at": "2020-05-04T02:44:57.000000Z"
}
},
{
"id": 18,
"plan_id": 8,
"review_site_id": 85,
"pull_frequency": "daily",
"pull_interval": 1,
"pull_times": [
"06:00"
],
"pull_days": [],
"created_at": "2026-06-19T06:21:21.000000Z",
"updated_at": "2026-06-19T06:21:21.000000Z",
"deleted_at": null,
"review_site": {
"id": 85,
"name": "Doordash",
"link": "doordash.com",
"review_site_button": "img-doordash.png",
"review_site_color": "#fb0000",
"max_rate": 5,
"status": 0,
"show": true,
"use_sau_scrapper": "N",
"publisher": "doordash.com",
"auth_type": "cookie",
"scraping_enabled": true,
"posting_enabled": true,
"self_form_enabled": "N",
"email_on_reply": "N",
"deleted_at": null,
"created_at": "2024-10-11T08:32:26.000000Z",
"updated_at": "2024-10-11T08:32:26.000000Z"
}
}
]
}
],
"meta": {
"billing_model": "usage-based",
"read_only": false
}
}
}200 — Plan-Based partner (read-only) · 200
200{
"data": {
"data": [
{
"id": 4,
"plan_name": "RM Core",
"price": 0,
"original_price": null,
"status": "active",
"plan_type": "plan-based",
"tier_slug": "core",
"enforcement_mode": "per-location",
"is_admin_managed": true,
"description": "Display + manual reply (hipages reviews only) + flagging (hipages only) + per-pull data. No solicitation, no AI features. Auto-applies to migrated tradies through November 2027.",
"plan_end_date": null,
"short_info": "Free transition tier (through Nov 2027)",
"created_at": "2026-05-24T11:28:25.000000Z",
"updated_at": "2026-06-19T11:45:35.000000Z",
"deleted_at": null,
"features": [
{
"id": 88,
"plan_id": 4,
"feature_name": "ai_response",
"enabled": true,
"service_limit": null,
"limit_type": null,
"included_units": null,
"overage_rate": null,
"hard_stop": true,
"created_at": "2026-06-19T11:45:35.000000Z",
"updated_at": "2026-06-19T11:45:35.000000Z",
"deleted_at": null,
"partner_billing_enabled": true
},
{
"id": 89,
"plan_id": 4,
"feature_name": "review_flag",
"enabled": true,
"service_limit": null,
"limit_type": null,
"included_units": null,
"overage_rate": null,
"hard_stop": true,
"created_at": "2026-06-19T11:45:35.000000Z",
"updated_at": "2026-06-19T11:45:35.000000Z",
"deleted_at": null,
"partner_billing_enabled": true
},
{
"id": 90,
"plan_id": 4,
"feature_name": "response_to_past_reviews",
"enabled": true,
"service_limit": null,
"limit_type": "monthly",
"included_units": 8,
"overage_rate": null,
"hard_stop": true,
"created_at": "2026-06-19T11:45:35.000000Z",
"updated_at": "2026-06-19T11:45:35.000000Z",
"deleted_at": null,
"partner_billing_enabled": true
},
{
"id": 91,
"plan_id": 4,
"feature_name": "response_posting",
"enabled": true,
"service_limit": null,
"limit_type": null,
"included_units": null,
"overage_rate": null,
"hard_stop": true,
"created_at": "2026-06-19T11:45:35.000000Z",
"updated_at": "2026-06-19T11:45:35.000000Z",
"deleted_at": null,
"partner_billing_enabled": true
},
{
"id": 92,
"plan_id": 4,
"feature_name": "review_widgets",
"enabled": false,
"service_limit": null,
"limit_type": null,
"included_units": null,
"overage_rate": null,
"hard_stop": false,
"created_at": "2026-06-19T11:45:35.000000Z",
"updated_at": "2026-06-19T11:45:35.000000Z",
"deleted_at": null,
"partner_billing_enabled": true
},
{
"id": 93,
"plan_id": 4,
"feature_name": "review_solicitation_email",
"enabled": false,
"service_limit": null,
"limit_type": null,
"included_units": null,
"overage_rate": null,
"hard_stop": false,
"created_at": "2026-06-19T11:45:35.000000Z",
"updated_at": "2026-06-19T11:45:35.000000Z",
"deleted_at": null,
"partner_billing_enabled": true
},
{
"id": 94,
"plan_id": 4,
"feature_name": "review_solicitation_sms",
"enabled": false,
"service_limit": null,
"limit_type": null,
"included_units": null,
"overage_rate": null,
"hard_stop": false,
"created_at": "2026-06-19T11:45:35.000000Z",
"updated_at": "2026-06-19T11:45:35.000000Z",
"deleted_at": null,
"partner_billing_enabled": true
},
{
"id": 95,
"plan_id": 4,
"feature_name": "insight_report",
"enabled": false,
"service_limit": null,
"limit_type": null,
"included_units": null,
"overage_rate": null,
"hard_stop": false,
"created_at": "2026-06-19T11:45:35.000000Z",
"updated_at": "2026-06-19T11:45:35.000000Z",
"deleted_at": null,
"partner_billing_enabled": true
},
{
"id": 96,
"plan_id": 4,
"feature_name": "competitive_analysis",
"enabled": false,
"service_limit": null,
"limit_type": null,
"included_units": null,
"overage_rate": null,
"hard_stop": false,
"created_at": "2026-06-19T11:45:35.000000Z",
"updated_at": "2026-06-19T11:45:35.000000Z",
"deleted_at": null,
"partner_billing_enabled": true
},
{
"id": 97,
"plan_id": 4,
"feature_name": "per_pull_data",
"enabled": true,
"service_limit": null,
"limit_type": null,
"included_units": null,
"overage_rate": null,
"hard_stop": true,
"created_at": "2026-06-19T11:45:35.000000Z",
"updated_at": "2026-06-19T11:45:35.000000Z",
"deleted_at": null,
"partner_billing_enabled": true
}
],
"plan_review_sites": [
{
"id": 23,
"plan_id": 4,
"review_site_id": 44,
"pull_frequency": "daily",
"pull_interval": 1,
"pull_times": [
"18:00"
],
"pull_days": null,
"created_at": "2026-06-19T11:45:35.000000Z",
"updated_at": "2026-06-19T11:45:35.000000Z",
"deleted_at": null,
"review_site": {
"id": 44,
"name": "Google",
"link": "http://maps.google.com",
"review_site_button": "img-google.png",
"review_site_color": "#3774ee",
"max_rate": 5,
"status": 0,
"show": true,
"use_sau_scrapper": "Y",
"publisher": "maps.google.com",
"auth_type": "oauth",
"scraping_enabled": true,
"posting_enabled": true,
"self_form_enabled": "N",
"email_on_reply": "N",
"deleted_at": null,
"created_at": "2017-01-09T11:33:00.000000Z",
"updated_at": "2020-05-04T02:44:57.000000Z"
}
},
{
"id": 24,
"plan_id": 4,
"review_site_id": 100,
"pull_frequency": "daily",
"pull_interval": 1,
"pull_times": [
"06:00"
],
"pull_days": null,
"created_at": "2026-06-19T11:45:35.000000Z",
"updated_at": "2026-06-19T11:45:35.000000Z",
"deleted_at": null,
"review_site": {
"id": 100,
"name": "hipages",
"link": "https://www.hipages.com.au",
"review_site_button": "img-hipages.png",
"review_site_color": "#FF6B00",
"max_rate": 5,
"status": 0,
"show": true,
"use_sau_scrapper": "N",
"publisher": null,
"auth_type": "restapi",
"scraping_enabled": true,
"posting_enabled": true,
"self_form_enabled": "Y",
"email_on_reply": "Y",
"deleted_at": null,
"created_at": "2026-05-14T00:00:00.000000Z",
"updated_at": "2026-05-14T00:00:00.000000Z"
}
}
]
}
],
"meta": {
"billing_model": "plan-based",
"read_only": true
}
}
}Errors
| Status | Meaning |
|---|---|
401 | The bearer token is missing, expired or invalid |
403 | Returned if none |
500 | Unexpected server error |
Example request
curl --request GET \
--url "https://production-api.shoutaboutus.com/api/v1/partner/plans/list" \
--header 'Authorization: Bearer <bearer-token>' \
--header 'Accept: application/json'Updated 9 days ago
Did this page help you?