Agencies

Set the monthly budget for a client project

The most your agency pays for this client project per calendar month, in euros excluding VAT, or null for no budget of its own (your project's spending cap still applies). When it is reached, new paid usage in the project gets a 402 billing_blocked and your agency gets one email that month.

put/clients/{id}/budget

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/clients/{id}/budget
  • 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:write)

Path parameters

idstring uuid required

The id of the client project.

Request body

monthly_budget_eurnumber nullable required

Response

The relation with the budget.

object'client_relation' required
idstring uuid required
status'pending' | 'active' | 'declined' | 'ended' required
stage'building' | 'client_owned' required
role'viewer' | 'builder' | 'admin' required
max_mode'test' | 'live' required
four_eyesboolean required
payer'client' | 'agency' required
budget_eurnumber nullable required
confirmed_atstring nullable required
ended_atstring nullable required
created_atstring required
ended_via'client' | 'agency' | 'admin' | 'handover' | 'expired' | 'cleanup'

Changes

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