Skip to main content

How to Link External Subscriptions to Arc XP Digital Subscriptions

Connecting a print or other external subscription is easy using the Arc Subscriptions developer APIs. This will create a “Linked subscription” that allows readers to access a digital entitlement. These subscriptions are not managed in Arc XP but this provides a method for print readers to have digital access as a bonus to their regular paper.

The developer APIs are only to connect a digital Subscription entitlement to a subscription in an external system. Currently Arc does not have API functionality for back and forth communication on a subscription status in an external system, so any changes need to be made using these developer APIs. It is not possible to make changes to linked subscriptions using the Customer Service Admin, clients must push changes to linked subscriptions through developer APIs.

Creating & Managing Linked Subscriptions

Linking an External Subscription to an Arc Product Entitlement

  1. Create the subscription product in Arc that you would like your linked user to have as their digital entitlement.

  2. Create a landing page for readers to register an account and enter details that the external system will use to verify their subscription.

  3. After the reader’s subscription has been verified in the external system, call the Sales Developer API

{
  "sku": "1A123", //Required: Arc Retail Product SKU
  "priceCode": "1A123", //Required: Price that is linked with the Product SKU
  "token": "1A123", //Required: client subscription identifier to link Arc and external system
  "expirationDateUTC": "2022-02-22 11:11:00", //Not required, if provided then subscription link will terminate on that date
  "clientId": "string" //Required: Arc Identity clientId
}

WebSocket Event: The START_SUBSCRIPTION event is sent after every successful linked subscription

Removing a Linked Entitlement

  1. Receive a confirmation that a linked subscription should be revoked. This could be due to cancelation of a print subscription or changes to entitlement.

  2. Confirm user ID and call the Revoke Subscription Developer API.

{
  "sku": "Revoke", //Required: Can enter REVOKE
  "priceCode": "Revoke", //Required: Can enter REVOKE
  "token": "1A123", //Required: client subscription identifier to link Arc and external system
}

WebSocket Event: The TERMINATE_SUBSCRIPTION event is sent after every successful revoke subscription.

Updating the Expiration Date

  1. Confirm the Arc XP Subscription ID to be updated

  2. Call the Extend API using the Arc Subscription ID with the new expiration date

{
  "newDateUTC": "2029-01-15 11:11:11", //require: new expiration date for the linked subscription
  "notes": "Customer requested a refund", //not required
  "reasonCode": "000" //Required
}

WebSocket event: The UPDATE_SUBSCRIPTION_EXPIRATION_DATE is sent after a successful extend and change of an expiration date

Reporting

All linked subscription additions, changes and terminations are included in the Activity Extract

In this section: