Integration Flows
This integration includes six process flows.
This integration includes the following process flows:
- Create/View Subscription
- Modify Subscription
- Renew Subscription
- Terminate Subscription
- Suspend Subscription
- Resume Subscription
To learn more about the product abbreviations used in these flows, see Understand the Subscription Management Integration.
Create / View Subscription
The integration creates subscriptions of complex configurable services with recurring prices and flexible durations as defined in CPQ.
- CDM: Get AddressId using AddressNumbers (shipping and billing addresses) for Account
- CDM: If Account addresses are not found, get AddressId using AddressNumbers (shipping and billing addresses) for Contact
- CDM: If Contact addresses are not found, create the addresses
- AR: Check if a site exists for the addresses
- AR: If not, then create a site
- Subscription: Create draft subscription
- Subscription: Add contact for account-based subscription
- Subscription: Activate subscription
Modify Subscription
The integration modifies configurations, changes quantities, upgrades or downgrades the service as defined in the CPQ configuration.
- CDM: Get AddressId using AddressNumbers (shipping and billing addresses) for Account
- CDM: If Account addresses are not found, get AddressId using AddressNumbers (shipping and billing addresses) for Contact
- CDM: If Contact addresses are not found, create the addresses
- AR: Check if a site exists for the addresses
- AR: If not, then create a site
- Subscription: Get subscription lines details for each line in a loop
- Subscription: Add/Update/Delete subscription lines for each line in a loop
- Subscription: Activate subscription
Suspend Subscription
The integration suspends, but does not terminate, an active subscription.
- CDM: Get AddressId using AddressNumbers (shipping and billing addresses) for Account
- CDM: If Account addresses are not found, get AddressId using AddressNumbers (shipping and billing addresses) for Contact
- CDM: If Contact addresses are not found, create the addresses
- AR: Check if a site exists for the addresses
- AR: If not, then create a site
- Subscription: Get subscription lines details for each line in a loop
- Subscription: Update subscription lines for each line in a loop
Resume Subscripiton
The integration resumes a suspended subscription.
- CDM: Get AddressId using AddressNumbers (shipping and billing addresses) for Account
- CDM: If Account addresses are not found, get AddressId using AddressNumbers (shipping and billing addresses) for Contact
- CDM: If Contact addresses are not found, create the addresses
- AR: Check if a site exists for the addresses
- AR: If not, then create a site
- Subscription: Get subscription lines details for each line in a loop
- Subscription: Update subscription lines (Resume SubscriptionProducts) for each line in a loop
- Subscription: Get updated subscription lines details for each line in a loop
- Subscription: Update subscription lines (with asset key) for each line in a loop
- Subscription: Activate subscription
Terminate Subscription
The integration deletes a subscription.
- CDM: Get AddressId using AddressNumber for Account
- CDM: If Account addresses are not found, get AddressId using AddressNumber for Contact
- CDM: If Contact addresses are not found, create address
- AR: Check if a site exists for the address
- AR: If not, then create site
- Subscription: Get subscription lines details for each line in a loop
- Subscription: Update subscription lines (Close) for each line in a loop
Renew Subscription
The integration renews subscriptions at the end of period of their original subscription date.
Note that a shopper cannot renew a subscription unless a renewal draft subscription has been created in Oracle Subscription Management via the ESS job. The Subscription Management GET
subscription product endpoint returns renew
as a valid action if a draft subscription is present for the current subscription.
- CDM: Get AddressId using AddressNumber for Account
- CDM: If Account addresses are not found, get AddressId using AddressNumber for Contact
- CDM: If Contact addresses are not found, create address
- AR: Check if a site exists for the address
- AR: If not, then create site
- Subscription: Get draft renew subscription
- Subscription: Get original subscription lines
- Subscription: Create new subscription
- Subscription: Add contact for account-based subscription
- Subscription: Activate subscription
- Subscription: Update original subscription lines to do-not-renew
- Subscription: Delete draft subscription lines for each line in a loop