APappdirect
Integration

Billing Usage V2

Changed on

Submit preconfigured, custom, or volume-priced metered usage data to be billed for a customer account. <br/> <br/> Volume pricing usage is always preconfigured, not custom. It is processed at 6:00 PM UTC, either on the last day of the billing period or, if delayed billing is configured (always recommended for volume pricing), on the last day of a defined number of days after the billing period ends. It must be submitted in requests that do not include other pricing models.

post/integration/v2/billing/usage

Request

Request body

idempotencyKeystring

Unique caller-generated identifier for the metered usage that is sent. Ensures duplicate submissions can be identified and an error returned. Required.

requestGroupIdstring nullable

A caller-generated identifier to group related metered usage requests. For example, 'January 2022' to group all requests that include January billing period events.

billableboolean

Indicates usage is billable (true) or estimated (false). Required.

Response

Metered usage report successfully received

requestIdstring

Unique system-assigned identifier for the metered usage request. Returned with the response.

idempotencyKeystring

Unique caller-generated identifier sent with the metered usage submission.

queryUsageStatusstring

API endpoint to fetch the processing status of all metered usage events submitted with the request.

Changes