Metered usage prerequisites

This topic is about Metered usage V2. Marketplaces use the Metered usage V1 API, Metered usage V2 API, or both, to support metered usage billing. See also: Metered usage V1.

Important

Metered usage v2 is currently in Early Availability status. Features in Early Availability status are only available in production to a limited number of customers based on fit with specific use cases. For more information about Early Availability status, see Product lifecycle phases. If you would like to use the product capabilities described here during the Early Availability phase, contact your AppDirect technical representative.

We recommend that you assess whether delayed invoicing is appropriate for your products that are configured for metered usage. See Delayed invoicing recommendation.

You must complete the following prerequisites before you can send a user's metered usage to a marketplace.

Configure products for metered usage

• To configure a product pricing plan or add-on product for preconfigured metered usage (the Metered usage setting) or custom metered usage (the Allow custom usage setting), refer to the following topics:
  • For product editions, see Add recurring editions or Add tiered editions.
  • For add-on products, see Edit recurring revenue model pricing or Edit tiered revenue model pricing.

Locate the marketplace base URL

To locate the base URL for the AppDirect-powered marketplace that hosts the user's account, look at the <marketplace> element in events that the marketplace sent to you. For example, a SUBSCRIPTION_ORDER.

You can also find it from the OpenID URL of the users who are members of this customer company account. To report usage, POST a JSON request to this endpoint URL: {base marketplace URL}/api/integration/v2/billing/usage.

See Authorize inbound API requests for information on how to securely access product APIs.