Skip to content
API Reference/
/
Create a Product Plan

Uberall API (20250708)

Enhance your application with Uberall's comprehensive API documentation

Download OpenAPI description
swagger.yaml
Overview
URL
https://uberall.com
Support
api@uberall.com
License
Licensed under Uberall
Languages
Servers
https://uberall.com/api/
Mock Server
https://docs.uberall.com/_mock/apis/swagger/

Users

Set up - Users

Operations

Business Connections

Set up - Business Connections

Operations

Businesses

Set up - Businesses

Operations

Configuration

Set up - Configuration

Operations

Sales Partners

Set up - Tenancy - Sales Partners

Operations

Monitoring

Set up - API Status

Operations

Product Plans

Set up - Tenancy - Product Plans

Operations

Get All Product Plans

Request

Get all product plans available to the current API user

Security
X-API-KEY or Authorization
Query
countrystring

Optional parameter to retrieve plans and supported directories for a specific country

curl -i -X GET \
  'https://uberall.com/api/product-plans?country=string' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Product Plans successfully retrieved

Body*/*
statusstringrequired
Enum"SUCCESS""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER""WRONG_PARAMETER_TYPE"
messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

The actual response object of the response

response.​plansArray of objects
Response
No content

Create a Product Plan

Request

Create a new Product Plan. The new Product Plan will be always created into PENDING_APPROVAL status.

Security
X-API-KEY or Authorization
Bodyapplication/jsonrequired

A Product Plan object

defaultPlanboolean

True, if this is the default ProductPlan. A new created business will get this product plan, if not declared differently.

descriptionstring

Description of the plan

identifierstring

The Product Plan identifier based on your internal identification system

namestringrequired

The name of the product plan

statusstring

One among PENDING_APPROVAL, ACTIVE, INACTIVE

Enum"ACTIVE""INACTIVE""PENDING_APPROVAL""DELETED"
automationDirectoriesArray of stringsunique

List of directories supported by this plan

Items Enum"FOURSQUARE""UBER""GOOGLE""WAZE""GOOGLE_MAPS""YELP""YELP_API""MEINESTADT""YELLOW_MAP""FOCUS"
billingPeriodinteger(int32)

Period in months for which the location is billed

countryPricesArray of objectsunique

List of country specific prices

defaultMarketDevelopmentFundsinteger(int32)

Default Market Development Funds

defaultOriginalPriceinteger(int32)

Default Original Price in cent

defaultPriceinteger(int32)

Mandatory if countryPrices is not populated. Define a global price for the Product Plan that gets applied for all countries

defaultPriceSetupinteger(int32)

Set-up price per location in cent

durationinteger(int32)required

Duration of the Product Plan in months

featuresArray of stringsunique

List of features supported by this plan

Items Enum"NEW_PHOTO_TYPES""ADS""ADS_READ""ADS_WRITE""ADVANCED_ANALYTICS_2_0""AI_KNOWLEDGEBASE""AI_LOCALISATION""AI_LOCATION_INFORMATION""AI_SUGGESTED_REPLIES""APPLE_POSTING"
initialBillingPeriodinteger(int32)

Initial Billing Period

initialDurationinteger(int32)

Initial Duration

curl -i -X POST \
  https://uberall.com/api/product-plans \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "defaultPlan": true,
    "description": "string",
    "identifier": "string",
    "name": "string",
    "status": "ACTIVE",
    "automationDirectories": [
      "FOURSQUARE"
    ],
    "billingPeriod": 0,
    "countryPrices": [
      {
        "country": "AF",
        "price": 0,
        "marketDevelopmentFunds": 99,
        "priceSetup": 0
      }
    ],
    "defaultMarketDevelopmentFunds": 0,
    "defaultOriginalPrice": 0,
    "defaultPrice": 0,
    "defaultPriceSetup": 0,
    "duration": 0,
    "features": [
      "NEW_PHOTO_TYPES"
    ],
    "initialBillingPeriod": 0,
    "initialDuration": 0
  }'

Responses

Product Plan successfully created

Body*/*
statusstringrequired
Enum"SUCCESS""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER""WRONG_PARAMETER_TYPE"
messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

The actual response object of the response

response.​productPlanResponseobject

Product Plan Response Model

Response
No content

Update a Product Plan

Request

Update an existing Product Plan. Only defaultPlan, description, name, status are updatable via API.

Security
X-API-KEY or Authorization
Path
idstringrequired

The uberall unique id of the Product Plan

Bodyapplication/jsonrequired

A Product Plan object

namestring

The name of the product plan

identifierstring

The Product Plan identifier based on your internal identification system

descriptionstring

Description of the plan

defaultPlanboolean

True, if this is the default ProductPlan. A new created business will get this product plan, if not declared differently

statusstring

Status of the Product Plan. Is possible to change an ACTIVE Product Plan to INACTIVE and vice versa.

Enum"ACTIVE""INACTIVE""PENDING_APPROVAL""DELETED"
curl -i -X PATCH \
  'https://uberall.com/api/product-plans/{id}' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "name": "string",
    "identifier": "string",
    "description": "string",
    "defaultPlan": true,
    "status": "ACTIVE"
  }'

Responses

Product Plan successfully updated

Body*/*
statusstringrequired
Enum"SUCCESS""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER""WRONG_PARAMETER_TYPE"
messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

The actual response object of the response

response.​productPlanResponseobject

Product Plan Response Model

Response
No content

Webhooks

Set up - Tenancy - Sales Partners - Webhooks

Operations

Auto Response

Products - Auto Response

Operations

Brand Data Points

Products - Brand Data Points

Operations

Dashboard

Products - Analytics - Dashboard

Operations

Dashboard Exports

Products - Analytics - Dashboard Exports

Operations

Data Point Filters

Products - Data Points - Data Point Filters

Operations

Data Points

Products - Data Points

Operations

Digital Asset Management

Products - Digital Asset Management

Operations

Near Me Check

Products - Near Me Check

Operations

Social Posting

Products - Social Posting

Operations

Status Check

Products - Status Check

Operations

Store Finder

Products - Store Finder

Operations

Templates

Products - Response Library - Templates

Operations

Batch Operation

Locations Hub - Locations - Batch Operations (excel)

Operations

Categories

Locations Hub - Categories

Operations

Collection Management

Locations Hub - Collections - Collection Management

Operations

Content List

Locations Hub - Collections - Content List

Operations

Locations Data

Locations Hub - Locations Data

Operations

Custom Items

Locations Hub - Collections - Custom Items

Operations

Events

Locations Hub - Collections - Events

Operations

Listings

Locations Hub - Locations - Listings

Operations

Labels

Locations Hub - Labels

Operations

Location Groups

Locations Hub - Location Groups

Operations

Persons

Locations Hub - Locations - Persons

Operations

Locations Photos

Locations Hub - Locations Photos

Operations

Products

Locations Hub - Locations - Product

Operations

Service Items

Locations Hub - Locations - Service Items

Operations

Suggestions

Locations Hub - Locations - Suggestions

Operations

Locations

Locations

Operations