Update Subscription’s External ID

The UpdateSubscriptionExternalId API in OCS.io facilitates the modification of a subscription’s external ID, allowing for customization to address specific operational needs.

Please note that attributes are not versioned, meaning that when you update subscription information, the new values take effect immediately. This change does not impact previously processed data.

API Overview

Fields Required for Updating Subscription’s External ID

The following table lists and describes the fields required to update a subscription’s external ID through the UpdateSubscriptionExternalId API:

Field Description

subscription

ID (Ref ID / External ID) of the Subscription.

externalId

New External ID of the Subscription.
Detailed API documentation and endpoint specifics are available here.

Request Validations

The following validations are performed when updating a subscription’s external ID:

  • Offer Subscription must be provided in the request, it must be already created in the system and must not be in Deactivated State.

  • External ID must be provided in the request, it must be unique and must not be already assigned to another Offer Subscription even in Deactivated State.

Update Subscription’s External ID Example

Use the following request’s body to update a subscription’s external ID:

{
  "requestId": "{{$guid}}",
  "subscription": {
    "externalId": "subscription_external_id"
  },
  "externalId": "new_subscription_external_id"
}

The outcome of the API call is as follows:

  • The external ID of the subscription with the old external ID subscription_external_id is updated to new_subscription_external_id.

  • The subscription is no longer accessible using the old external ID subscription_external_id. The new external ID new_subscription_external_id must be used to access the subscription.