Overview
Metered subscriptions are billed based on actual consumption rather than a fixed license count. Consumption must be reported before billing can be calculated. Billing for consumption-type subscriptions happens in arrears for the previous billing period.
This guide explains how to create a system that submits each customer's consumption automatically. Once consumption is submitted, billing is calculated automatically on the billing day.
Submitting Consumption in Bulk via API
Consumption data for metered products or add-ons can be submitted in bulk using two API calls.
-
A POST request to submit the consumption data. The response includes a
taskId. -
A GET request using the
taskIdto check the submission status. The GET URL is also available in the response headers of the POST request.
See the Swagger documentation for the SellerServiceBulkConsumptions API collection.
Other Consumption Endpoints
Older endpoints are available for single-subscription consumption submission. These are not recommended for new integrations. The bulk submit API above is the recommended approach.
The legacy endpoints (API Collection: SellerServiceConsumptions) allow only one subscription at a time. The bulk API allows multiple subscriptions in a single call.
|
Operation |
Description |
Method |
API |
|---|---|---|---|
|
Return Seller Consumption |
Returns all seller service consumption subscriptions |
POST |
|
|
Submit Seller Consumption |
Submit seller service consumptions |
PUT |
|