Billing of products based on publisher metrics

Marketplace provides an API to account for product consumption so that products can track consumption and invoice Yandex Cloud users through Yandex Cloud Billing. Integration with the API is required for any product that uses one or more pricing plans with custom metrics to account for consumption events.

Based on the metrics you set, an application (product) should register consumption events and send this data using the consumption metering API. You can send one or more consumption events per request.

For the specification of the service plan-based billing API, see Marketplace Metering API: REST reference.

Development and testing recommendationsDevelopment and testing recommendations

• To authenticate your app, use the service account with the marketplace.meteringAgent role.
• To create a pricing plan for a product with custom metrics, submit a request in the Marketplace partner's account. Use the skuId assigned to the plan to send product consumption records.
• During installation, your application must verify the user has enough permissions to work with it and that sending consumption events is possible. To do this, send the write request with the validateOnly: true parameter.
• The application should take into account that an attempt to send consumption events may fail.
• Before you list your product, we recommend testing its integration with the API using the demo product ID and SKU: productId: f2e4tmlj4qqciunhr7e6 and skuId: dn272e8979uvek5cnuhk. For examples of working with the API, see How to get started with Marketplace Metering API.

Integration testingIntegration testing

For code examples and a test server you can use to check the Metering API integration, see this Github repository.