Set up a limit notification for a rate plan

You can create a limit notification for a rate plan using the monetization API.

You can notify developers through email when they're nearing or have reached a certain limit of a Volume Banded or Bundle rate card plan they've purchased. For example, if developers purchase a volume-banded plan with 1,000 calls in a bundle, you can notify them when they reach 800 calls (80% usage) or when they've spent $500 on API calls.

Notifications work with a single currency. You can't use this notification type if products use different currencies.

To set up a limit notification for a rate plan using the API, perform the following steps:

Configuring the notification condition and action

To trigger the notification for a rate plan limit, set the following attributes:

RATEPLAN - Type of notification to send.

PUBLISHED - Set this attribute to TRUE in order to trigger notifications on published rate plans.

Then, specify one of the following attributes:

Transactions - Number of transactions. For example, notify developers when they reach 1000 transactions. Must be an integer value and only > and = operators are allowed.

FeeExposure - Amount of dollars or points accumulated on transactions. Must be an integer value and only > and = operators are allowed. FeeExposure doesn't include setup, recurring, or termination fee amounts. For example, notify developers when the cost of their API transactions reaches $500. FeeExposure calculations vary depending on the tax rate.

If a single transaction qualifies for more than one notification, multiple notifications are sent.

The following payload triggers an email notification when the number of transactions reaches 800: