POST /v1/installations/{integrationConfigurationId}/billing
Sends the billing and usage data. 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 |
|---|---|---|---|
usage[] |
Array | Yes | |
usage[].units |
String | Yes |
Metric units. Example: "GB" |
usage[].name |
String | Yes |
Metric name. |
usage[].resourceId |
String | No |
Partner's resource ID. |
usage[].planValue |
Number | No |
The limit value of the metric for a billing period, if a limit is defined by the plan. |
usage[].type |
String | Yes |
\n Type of the metric.\n - total: measured total value, such as Database size\n - interval: usage during the period, such as i/o or number of queries.\n - rate: rate of usage, such as queries per second.\n Possible values:
|
usage[].periodValue |
Number | Yes |
Metric value for the billing period. Could be a final or an interim value for the period. |
usage[].dayValue |
Number | Yes |
Metric value for the day. Could be a final or an interim value for the day. |
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. |
billing |
Yes |
Billing data (interim invoicing data). |
|
period |
Object | Yes |
Period for the billing cycle. The period end date cannot be older than 24 hours earlier than our current server's time. |
period.end |
String | Yes | |
period.start |
String | Yes | |
eod |
String | Yes |
End of Day, the UTC datetime for when the end of the billing/usage day is in UTC time. This tells us which day the usage data is for, and also allows for your "end of day" to be different from UTC 00:00:00. eod must be within the period dates, and cannot be older than 24h earlier from our server's current time. |
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.