POST /v1/installations/{integrationConfigurationId}/billing/balance
Sends the prepayment balances. The partner should do this at least once a day and ideally once per hour.
Use the credentials.access_token we provided in the Upsert Installation body to authorize this request.
Servers
- https://api.vercel.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
integrationConfigurationId |
String | Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
timestamp |
String | Yes |
Server time of your integration, used to determine the most recent data for race conditions & updates. Only the latest usage data for a given day, week, and month will be kept. |
balances[] |
Array | Yes | |
balances[].resourceId |
String | No |
Partner's resource ID, exclude if credits are tied to the installation and not an individual resource. |
balances[].nameLabel |
String | No |
The name of the credits, for display purposes, e.g. "Tokens" |
balances[].currencyValueInCents |
Number | Yes |
The dollar value of the credit balance, in USD and provided in cents, which is used to trigger automatic purchase thresholds. |
balances[].credit |
String | No |
A human-readable description of the credits the user currently has, e.g. "2,000 Tokens" |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.