Add one-time USD credit top-up
POST
/v1/billing/admin/{userId}/top-upGrant a purchased one-time USD credit top-up balance to a specific user account.
How to call this endpoint
Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.
Path, query, and header parameters
These parameters control which ACP object the endpoint acts on and how the request is processed.
Path parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| userId | path | string | Yes | User ID |
Query parameters
None.
Body schema
Content type: application/json · Required
| Field | Type | Required | Description |
|---|---|---|---|
| amountUsd | number | No | USD credit amount to grant. Preferred over legacy amount. |
| amount | number | No | Legacy alias for amountUsd. |
| description | string | No | Human-readable description. |
| metadata | object | No | Free-form metadata object. |
What the API returns
Each response code below includes the documented payload shape for the ACP API.
200One-time USD credit top-up grantedapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| success | boolean | No | Whether the request succeeded. |
| userId | string | No | User ID. |
| addedAmount | number | No | — |
| addedAmountUsd | number | No | — |
| topUpBalance | number | No | — |
| topUpBalanceUsd | number | No | — |
| topUpTotalPurchased | number | No | — |
| topUpTotalPurchasedUsd | number | No | — |