Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

RingCentral Subscriptions API

General interface to manage subscriptions

RingCentral Subscriptions API is one of 88 APIs that RingCentral publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Subscriptions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 3 paths, and defines 18 schemas. It is described by OpenAPI 3.0.3, at version 1.0.58-20240529-47eda8bd.

Requests are made against 4 base URLs: https://platform.ringcentral.com, https://media.ringcentral.com, https://platform.devtest.ringcentral.com, https://platform.devtest.ringcentral.com.

6 operations 3 paths 18 schemas 1 DELETE2 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.58-20240529-47eda8bd
Servers
https://platform.ringcentral.com
https://media.ringcentral.com
https://platform.devtest.ringcentral.com
https://platform.devtest.ringcentral.com
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

RingCentral Subscriptions API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow. By default, every request must be authenticated.

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Subscriptions 6

General interface to manage subscriptions

GET
/restapi/v1.0/subscription
List Subscriptions
listSubscriptions → 200500503
POST
/restapi/v1.0/subscription
Create Subscription
createSubscription body → 200400403500503
GET
/restapi/v1.0/subscription/{subscriptionId}
Get Subscription
readSubscription 1 param → 200404500503
PUT
/restapi/v1.0/subscription/{subscriptionId}
Update Subscription
updateSubscription 1 param body → 200400403404500503
DELETE
/restapi/v1.0/subscription/{subscriptionId}
Cancel Subscription
deleteSubscription 1 param → 204404500503
POST
/restapi/v1.0/subscription/{subscriptionId}/renew
Renew Subscription
renewSubscription 1 param → 200400403404500503

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are SubscriptionInfo (10 properties), MobileDeliveryModeRequest (3 properties), WebhookDeliveryModeRequest (3 properties), DisabledFilterInfo (3 properties). Each schema is shown below with its type and property counts.

WebhookDeliveryModeRequest
object
3 properties 2 required
MobileDeliveryMode
NotificationDeliveryMode
Notification delivery transport information
ApiErrorWithParameter
The error model with additional attributes which can be used for HTTP 400/409 This is a deprecated model: "ApiError" model can be used instead with arbitrary a…
ApiError
object
Generalized API error structure suitable for any error type
2 properties 2 required
DisabledFilterInfo
object
3 properties 2 required
WebSocketDeliveryMode
object
1 property 1 required
ApiErrorResponseModel
object
Standard error response model which is returned in case of any unsuccessful operation
1 property 1 required
UpdateSubscriptionRequest
object
2 properties 1 required
WebhookDeliveryMode
object
3 properties 3 required
NotificationDeliveryModeRequest
Notification delivery transport information
PubNubDeliveryMode
PubNubDeliveryModeRequest
object
2 properties 1 required
ParameterizedErrorResponseModel
object
Standard error response which may include parameterized errors
1 property 1 required
MobileDeliveryModeRequest
object
3 properties 3 required
SubscriptionInfo
object
10 properties 7 required
CreateSubscriptionRequest
SubscriptionListResource
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ringcentral-subscriptions-api-openapi.yml Raw ↑

Other APIs RingCentral publishes across the network.

RingCentral SMS API
RingCentral Team Messaging API
RingCentral Video API
RingCentral Fax API
RingCentral Data API
RingCentral Audio and Video AI API
RingCentral Call Log API
RingCentral Call Analytics API
RingCentral Presence API
RingCentral Voicemail API
RingCentral Provisioning API
RingCentral Webhooks and Subscriptions API