Subscription Management

This chapter provides a comprehensive guide to managing subscriptions within the OCS.io. It covers various aspects of subscription management, including updating and retrieving subscription information. The following sub-chapters are included:

The UpdateSubscriptionExternalId API allows for the modification of a subscription’s external ID. This API provides the necessary functionality to update the external identifier used for subscription management.

The UpdateSubscriptionCustomName API covers the management of custom names associated with subscriptions. This includes updating the custom name to reflect changes in subscription details.

The UpdateSubscriptionCustomAttributes API enables the modification of custom attributes for a subscription. Custom attributes are implemented as key-value pairs, and the system must provide the full set of key-value pairs in the request.

The UpdateSubscriptionState API allows for updating the state of a subscription. This is essential for managing the lifecycle of a subscription, including activating, suspending, or terminating the subscription based on business requirements.

The ReadSubscription API enables the retrieval of detailed information about a subscription using its unique identifier. This API is crucial for accessing subscription data for management and reporting purposes.

Each sub-chapter provides detailed information on the respective API, including usage examples, parameters, and expected responses. This guide aims to equip developers with the knowledge and tools necessary to effectively manage subscriptions within the OCS.io.