# Doanh thu

> Doanh thu từ các sao kê nền tảng đã ghi nhận, theo tháng, bản phát hành hoặc nền tảng, kèm phần của nghệ sĩ.

<!-- Generated from openapi/hills-v1.json by scripts/api-reference.mjs. Edit the operation in hills-music (server/lib/ops), not this page. -->

Doanh thu từ các sao kê nền tảng đã ghi nhận, theo tháng, bản phát hành hoặc nền tảng, kèm phần của nghệ sĩ.

Base URL `https://api.hillsmusic.com/v1`. Mọi request đều gửi một API key: `Authorization: Bearer hm_live_…`.

- Doanh thu

<a id="earnings"></a>

## Doanh thu

`GET /v1/earnings` · Scope: `earnings:read`

Doanh thu từ các sao kê nền tảng đã ghi nhận, tính bằng USD. amount_usd là tổng của bạn; member_share_usd là phần mà các tỷ lệ chia doanh thu của bạn dành cho nghệ sĩ và hãng đĩa.

### Parameter

| Parameter | Vị trí | Kiểu | Bắt buộc | Mô tả |
| --- | --- | --- | --- | --- |
| `by` | query | `month` \| `release` \| `store` | Không | Cách nhóm (mặc định month). |
| `months` | query | integer (1–60) | Không | Số tháng lấy về trước (mặc định 12). |

### Ví dụ request

```bash
curl "https://api.hillsmusic.com/v1/earnings?by=store&months=6" \
  -H "Authorization: Bearer $HILLS_API_KEY"
```

### Phản hồi `200`

```json
{
  "by": "store",
  "months": 6,
  "currency": "USD",
  "data": [
    {
      "key": "Spotify",
      "label": "Spotify",
      "amount_usd": 1520.42,
      "member_share_usd": 1064.29,
      "units": 412003
    }
  ]
}
```

### Lỗi

| Mã trạng thái | Khi nào |
| --- | --- |
| 400 | invalid: một parameter bị sai; field cho biết parameter nào. |
| 401 | unauthenticated, invalid_key, key_revoked, key_expired hoặc test_keys_retired. |
| 403 | insufficient_scope: key thiếu scope; scope cho biết scope nào. account_inactive hoặc api_not_in_plan. |
| 429 | rate_limited: chờ số giây ghi trong Retry-After. |

Nguồn: https://developer.hillsmusic.com/vi/reference/earnings/