Agencies

Get the usage of a client project

Costs and usage per calendar month (UTC), oldest first: cost_eur with cost_by_source and cost_by_payer (client: the project's own credit, agency: paid by your agency), top_ups_eur and the app meters, plus the current payer and budget_eur. For invoicing your client with your own markup, or your own client portal.

get/clients/{id}/usage

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/clients/{id}/usage
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.hypamoon.com/oauth/authorize, token URL https://api.hypamoon.com/oauth/token, scopes: clients:read)

Path parameters

idstring uuid required

The id of the client project.

Query parameters

monthsinteger

How many months back, the current month included (at most 12).

Response

Usage per month.

object'client_usage' required
project_idstring uuid required
currency'EUR' required
payer'client' | 'agency'
budget_eurnumber nullable

Changes

No recorded changes to this operation across all 1 revision of this API.