Business Subscriptions API

📘
Migrating from an existing API?
Checkout the Changelog and Migration Guide

📘
This is a Yelp Partner API
Access is disabled by default. See Yelp Partner APIs on how to get access.

Overview

The Business Subscriptions API allows Yelp partners to manage their business subscriptions. Business subscriptions are managed separately per use case. Different subscription types can now be updated within one API call.

The subscriptions can have the following types that determine what they are used for:

Location Subscriptions (subscription type YELP_KNOWLEDGE)
Subscribed businesses will be part of the generated partner feed.
Listing Management (subscription type LISTING_MANAGEMENT)
Subscribed business's listing can be managed.
Webhooks (subscription type WEBHOOK)
Receive real-time notifications about events triggered on the subscribed businesses.

Requests are processed asynchronously

The add and delete endpoint requests are processed asynchronously. A successful response from these endpoints only represents the successful start of processing the request. It's not possible to await the actual adding or removing of business subscriptions. Expect 99% of requests to be processed within 15 minutes.

Authentication

The API uses your Yelp Fusion Api Key for authentication. See Fusion Authentication for details.

Your Yelp Fusion Client needs to be enabled for Business Subscriptions API. Please send your Client ID and the subscription types that you are going to manage to [email protected].

Deprecation

The Business Subscriptions API replaces the Location Subscriptions v1, Location Subscriptions v2, Listing Management and Webhooks APIs. These APIs will no longer be supported after July 2023 and turned off January 2024.
Instead of separating these subscriptions by endpoints, they are separated by type into this single API. Follow the Migration Guides to get started with the Business Subscriptions API if you used one of the just mentioned Subscriptions APIs before. Click on the API that you are currently using to get to the Migration Guide: Location Subscription V1, Location Subscriptions V2, Listing Management, Webhook.

Business IDs

The Business Subscriptions API requires Business IDs when managing subscriptions. Please reference the Business Match API documentation on how to get Business IDs for Yelp listings.

All the Business Subscriptions API endpoints have a default rate limit of 5 requests per second per client per endpoint. The limits are configurable for clients, contact us to know more. For more details, see QPS Rate Limiting