Billing

Get the prepaid balance

A live project pays in advance: you top up a balance in the portal (https://app.hypamoon.com/balance) and every SMS, call minute and number is deducted from it immediately. This returns the balance, what was spent this calendar month against the spending cap, the automatic top-up settings and the latest 20 transactions, newest first. All amounts are in euro, excluding VAT. Read-only: topping up and the automatic top-up settings are in the portal. With a test key you see the balance of the live project with test: true. Test mode is free, except AI above the free daily test budget (chat replies, agent model calls), which is deducted from this balance.

get/balance

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/balance
  • 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: project:read)

Response

The balance with the latest transactions.

balance_eurnumber required

The prepaid balance in euro, excluding VAT. Can be slightly below zero after a call that ran on.

currency'EUR' required

Always EUR.

spent_this_month_eurnumber required

What was deducted this calendar month (minus refunds). Counts toward the spending cap.

spend_cap_eurnumber nullable required

The spending cap per calendar month, or null without one.

testboolean required

true with a test key: you see the balance of the live project, read-only. Test mode is free and never touches the balance.

Changes

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