Subscription management service

About Subscription management service

Subscription management service automatically notifies you on the following customer events associated with your product:

  • new subscription, either trial or paid
  • updated subscription
  • suspended and resumed subscription
  • canceled subscription

Event notifications include the following supporting information:

  • customer details
  • product edition details
  • event details

Event notification options

To configure notifications, you have two options, both provide the same information:

  • Email - notifications will be immediately sent for each event to an email address you provide. The email option is a good way to get started while your engineering team works on integrating using a webhook for full automation.  The email notifications are designed for awareness of events; the email option should not be used for automation in your business systems.

  • Lifecycle API with webhook - integration is focused on automating the full lifecycle to provide a better user experience that allows a customer to use your product within minutes of purchasing or requesting a trial from the marketplace.  In some cases, this requires an immediate/automated response from you for time-sensitive actions such as provisioning your service, providing license keys, and registering entitlement if needed.  Integration using a webhook is the preferred way to integrate the marketplace with your business systems. For more information, refer to API reference.

Sources for event notification data

Each event notification contains several attributes with associated data. The following table shows who contributes the data associated to each attribute, either partner, customer, or Red Hat Marketplace.

AttributeSourceDescription
Company nameCustomer - provided when the account is createdThe name of the company that owns the account, or “Not available” if not provided or is a personal account (some Fortune 500 clients can register for trials with an email address only, so the email domain can help you understand the user’s company).
Street addressCustomer - provided when the account is createdThe street address of the company. Not available for all trials (some Fortune 500 clients can register for trials with an email address only).
CityCustomer - provided when the account is createdThe city of the company. Not available for all trials. (some Fortune 500 clients can register for trials with an email address only)
Postal codeCustomer - provided when the account is createdThe postal code for the company. Not available for all trials. (some Fortune 500 clients can register for trials with an email address only)
State/Province/RegionCustomer - provided when the account is createdThe state/province/region of the company. Not available for all trials. (some Fortune 500 clients can register for trials with an email address only)
CountryCustomer - provided when the account is createdThe country code for the account billing address
User first nameCustomer - provided when the account is createdThe first name of the user requesting the action
User last nameCustomer - provided when the account is createdThe last name of the user requesting the action
User emailCustomer - provided when the account is createdThe email address of the user requesting the action
ActionRed Hat MarketplaceThe description of the action, either: subscribe, suspend, canceled, update, resume.
IDRed Hat MarketplaceUnique subscription id. This subscription ID will remain the same throughout the life of the subscription. If the subscriptions starts as a trial, the subscription ID will be retained if the customer upgrades to a purchase.
Edition IDRed Hat MarketplaceUnique id of the product’s edition being subscribed to. This ID will remain the same even if the editionName is changed.
Edition namePartner - provided in the edition editorName for the edition
TypeRed Hat MarketplaceType of subscription, either trial, free or purchase
Purchase termPartner - provided in the edition editorThe term/duration of the subscription term. This field is also the term for trials.
Term unit (future)Partner - provided in the edition editorThe value for the subscription term/duration, either hours, days, weeks, months, or years
Start date (future)Partner - provided in the edition editorFor the email notification, this is set to the purchase date for products that are available to the customer immediately (such as software/Operators). For the webhook integration, this field depends on a success reply from your endpoint to indicate the product has been provisioned and is ready to use by the customer
Renew typePartner - provided in the edition editorThis value is calculated based on the Start Date and the Purchase Term
Vendor charge IDPartner - provided in the edition editorThis value is so you can provide an identifier that maps to your business systems (it may be called a SKU, part number, plan identifier, etc.). It is a string that is meaningful to you and your business systems. If you do not provide this value, RHM will generate a system value.
QuantityCustomer - selected at checkoutThe quantity ordered by the customer.
Usage meter IDPartner - provided in the edition editor as part of metering setupFor usage/metered editions only. Format: domain:kind:label
Account IDRed Hat MarketplaceUnique ID of account that owns the subscription. This ID will remain the same even if the Company Name or user information is changed.
API versionRed Hat MarketplaceThe version of the Lifecycle API
Retry countRed Hat MarketplaceThe number of times this notification has been retried

Example data included on email notifications

Here are examples of the content for email notifications. For example data included on API notifications, refer to API reference.

Example trial registration email

Subscription ordered

Requestor details

Red Hat Marketplace Account ID: 5f31abeb88888e001b1f171c

Company Name: Rocket Adventures

Address 1: 1200 5th Ave #1100

City: Seattle

Postal Code: 98101-3105

State: WA

Country Code: US

First name: John

Last name: Doe

Email: john.doe\@rocketadeventures.com

Edition details

Subscription ID: 5fd2a7e8908e88888c7f0e71

Product ID: 13e122ce06ac87807c6d8888fd461fe4

Product Name: Acme Rocket Trial

Edition ID: rhmccp-4adbb5b2-3ff6-8888-8d03-f368c0a52f2d

Edition Name: Free Trial

Type: TRIAL

Purchase Term: 30

Renew Type: TERMINATE

Edition Charges

SKU864327-Trial: 1 [Note: this is Vendor Charge ID: Quantity]

Event details

API Version: 1

Event Type: subscription

Event Id: 9bf18643-2b27-4444-a5b3-888884c3eb2c

Retry Count: 0

Action: subscribe

Example purchase email

Subscription ordered

Requestor details

Red Hat Marketplace Account ID: 5e96340d6ee7cc0099999dd5

Company Name: Rocket Adventures

Address 1: 1200 5th Ave #1100

City: Seattle

Postal Code: 98101-3105

State: WA

Country Code: US

First name: John

Last name: Doe

Email: john.doe\@rocketadeventures.com

Edition details

Subscription ID: 5fd287a8c3d1c9999cbd15be

Product ID: 7fa13fdf699999ec566e38b8cd29a11e

Product Name: Acme Rocket

Edition ID: TBD

Edition Name: Professional Edition

Type: PURCHASE

Purchase Term: 1

Renew Type: ORIGINAL_TERM

Edition Charges

SKU864327: 1 [Note: this is Vendor Charge ID: Quantity]

Event details

API Version: 1

Event Type: subscription

Event Id: f618c07e-979a-43f3-999f-eaf5c221ff43

Retry Count: 0

Action: subscribe

Configure notification service

Procedure

  • To navigate to the notification service configuration page, on the Product setup workflow, click Configure product notification service.