Alphaus Cost API
Cost API. Base URL: https://api.alphaus.cloud/m/blue/cost
Operations 73
POST
/v1/invoicegroupcosts:read
WORK-IN-PROGRESS: Read the invoice group costs. Only available in Ripple.
#
POST
/v1/invoiceoverviews:read
WORK-IN-PROGRESS: Read the invoice overviews. Only available in Ripple.
#
POST
/v1/reports:export
Exports a vendor report and delivers results via email notification channel. Supports multiple report types per vendor. For AWS, this covers RI/SP utilization reports. Returns a lo
#
POST
/v1/{vendor}/accounts/customers/accounts:check
WORK-IN-PROGRESS: Check inputed accountIds belong to current MSP or not
#
GET
/v1/{vendor}/accounts/{id}
Gets a vendor account. This API includes all of the account's metadata. See https://alphauslabs.github.io/blueapi/ for the list of supported attributes.
#
PUT
/v1/{vendor}/accounts/{id}
WORK-IN-PROGRESS: Updates a vendor account. Only available in Ripple.
#
POST
/v1/{vendor}/adjustments:read
Reads the non-usage-based details of an organization (Ripple) or billing group (Wave[Pro]).
#
GET
/v1/{vendor}/alerts/{id}
Get the budget alerts for the account id. Only available in Wave(Pro).
#
DELETE
/v1/{vendor}/alerts/{id}
Delete the budget alerts for the account id. Only available in Wave(Pro).
#
POST
/v1/{vendor}/alerts/{id}
Create the budget alerts for the account id. Only available in Wave(Pro).
#
PUT
/v1/{vendor}/alerts/{id}
Update the budget alerts for the account id. Only available in Wave(Pro).
#
POST
/v1/{vendor}/aors:read
Reads all vendor account-original-resources. Account that have not been used for one month will no longer be retrieved.
#
DELETE
/v1/{vendor}/budget/{budgetId}
Removes monthly budget for the account/acctgroup id from database.
#
GET
/v1/{vendor}/calculation/prerequisites/{month}
WORK-IN-PROGRESS: List the prerequisites for cost calculations.
#
GET
/v1/{vendor}/calculations/schedules
Lists the schedules of your monthly calculations. Only available in Ripple.
#
POST
/v1/{vendor}/calculations/schedules
Creates a schedule to trigger your monthly calculations. At the moment, only one schedule is allowed per account. Only available in Ripple.
#
DELETE
/v1/{vendor}/calculations/schedules/{id}
Deletes the schedule of your monthly calculations. Only available in Ripple.
#
GET
/v1/{vendor}/calculator/config
WORK-IN-PROGRESS: Gets the vendor cost calculator's current configuration.
#
GET
/v1/{vendor}/calculator/config/costmods
Lists the cost calculator's cost modifiers. At the moment, the supported {vendor} is 'aws'. Only available in Ripple.
#
DELETE
/v1/{vendor}/calculator/config/costmods/{id}
Deletes a cost modifier. At the moment, the supported {vendor} is 'aws'. Only available in Ripple.
#
POST
/v1/{vendor}/calculator/running:read
Lists the vendor calculator's queued accounts for calculation.
#
GET
/v1/{vendor}/costattrs
WORK-IN-PROGRESS: Reads the available cost attributes of an organization (Ripple) or billing group (Wave).
#
POST
/v1/{vendor}/costattrs:read
Reads the available cost attributes of an organization (Ripple) or billing group (Wave).
#
GET
/v1/{vendor}/costfilters
Lists the usage-based cost filter condition. Only available in Wave(Pro).
#
DELETE
/v1/{vendor}/costfilters/{filterId}
Deletes the usage-based cost filter condition. Only available in Wave(Pro).
#
PUT
/v1/{vendor}/costfilters/{filterId}
Updates the usage-based cost filter condition. Only available in Wave(Pro).
#
POST
/v1/{vendor}/costfilters/{filterId}:export
Exports the usage-based cost filter condition. Only available in Wave(Pro).
#
POST
/v1/{vendor}/costs:calculate
Triggers monthly calculations for costs and invoices at either organization or billing group level.
#
POST
/v1/{vendor}/costs:read
Reads the usage-based cost details of an organization (Ripple) or billing group (Wave).
#
POST
/v1/{vendor}/coverage/ondemand/{orgId}:read
Get ondemand cost details for an organization (or MSP).
#
POST
/v1/{vendor}/coverage/options/{orgId}:read
Get coverage options details for an organization (or MSP).
#
GET
/v1/{vendor}/forecasts
Fetches cost forecasts for the specified billing group. Includes historical cost (up to previous month) and forecasted cost (up to three months for now).
#
GET
/v1/{vendor}/forecasts/month-on-month/{level}/{id}
Fetches previous month cost vs current month forecast vs current accumulated cost per category for id.
#
GET
/v1/{vendor}/forecasts/month-to-date/{level}/{id}
Fetches current month daily forecast vs current accumulated daily cost for id.
#
GET
/v1/{vendor}/forecasts/monthly/{level}/{id}
Fetches monthly accumulated costs vs forecasted cost vs budget for the id.
#
POST
/v1/{vendor}/payers
DEPRECATED: Registers a vendor payer account. This is now deprecated for AWS payer accounts. To register an AWS payer account, check out the 'CreateDefaultCostAccess' API.
#
POST
/v1/{vendor}/payers/basicdetails
WORK-IN-PROGRES: Registers a vendor payer account with their basics details such as accountId and accountName.
#
PUT
/v1/{vendor}/payers/basicdetails/{id}
WORK-IN-PROGRES: Updates a vendor payer account's basics details.
#
POST
/v1/{vendor}/payers/{id}/billingtransfer
WORK-IN-PROGRESS: Setup payer's billing transfer information
#
GET
/v1/{vendor}/payers/{id}/proforma
Gets a payer account's proforma reports. Applicable for AWS payer accounts only.
#
GET
/v1/{vendor}/payersextended
Lists vendor payer accounts with extended information. WORK IN PROGRESS
#
GET
/v1/{vendor}/payersextended/{id}
Gets a vendor payer account with extended information. WORK IN PROGRESS
#
POST
/v1/{vendor}/recommendations/{orgId}:read
WORK-IN-PROGRESS: Get cost opmtimization recommendations for an organization (or MSP).
#