Alphaus GuaranteedCommitments API
(Alpha) GuaranteedCommitments API. Base URL: https://api.alphaus.cloud/m/blue/gc
Alphaus GuaranteedCommitments API is one of 15 APIs that Alphaus publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include GuaranteedCommitments. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 43 operations across 43 paths, and defines 101 schemas. It is described by OpenAPI 3.2.0, at version v1.
Requests are made against a single base URL, https://api.alphaus.cloud/m/blue.
43 operations
43 paths
101 schemas
1 DELETE22 GET20 POST
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 43
Across 43 paths, the API surfaces 43 operations — 1 DELETE, 22 GET, 20 POST. Each is listed below with its method, path, parameters, and response codes.
GuaranteedCommitments 43
(Alpha) GuaranteedCommitments API. Base URL: https://api.alphaus.cloud/m/blue/gc
GET
/v1/commitments
WORK-IN-PROGRESS: Retrieves a list of commitments.
POST
/v1/commitments/plan/{planId}/apply
WORK-IN-PROGRESS: Executes a commitment purchase plan, initiating the commitment purchase process.
GET
/v1/commitments/purchaseplans
WORK-IN-PROGRESS: Retrieves purchase plan of a company.
GET
/v1/commitments/purchaseplans/availabletypes
WORK-IN-PROGRESS: Only works for Alphaus for now. Retrieves the available commitment types for a given provider.
POST
/v1/commitments/purchaseplans/custom
WORK-IN-PROGRESS: Only works for Alphaus for now. Creates a custom (top-down) commitment purchase plan.
GET
/v1/commitments/purchaseplans/draft
WORK-IN-PROGRESS: Retrieves the drafted purchase plans
DELETE
/v1/commitments/purchaseplans/draft/{draftPlanId}
WORK-IN-PROGRESS: Deletes a drafted purchase plan.
POST
/v1/commitments/purchaseplans/draft/{planId}
WORK-IN-PROGRESS: Saves a commitment purchase plan as draft.
GET
/v1/commitments/purchaseplans/{planId}
WORK-IN-PROGRESS: Retrieves full details of a specific purchase plan of a company. Includes the basic info, detailed metrics, commitment line items, covered infrastructure resource matches, and audit…
POST
/v1/commitments/purchaseplans:update
WORK-IN-PROGRESS: Get the updated details of the plan after the apply plan.
GET
/v1/commitments/resources
WORK-IN-PROGRESS: Only works for Alphaus for now. Retrieves a paginated list of reservable infrastructure resources for a segment. Supports filtering, sorting, and a date range for usage aggregation.
GET
/v1/commitments/{commitmentId}/chart
WORK-IN-PROGRESS: Generates time-series chart data for commitment metrics over the specified time period.
GET
/v1/commitments/{commitmentId}/utilization
WORK-IN-PROGRESS: Generates utilization data for commitment over the active period.
GET
/v1/managements/accounts
WORK-IN-PROGRESS: Lists payer accounts associated with the organization. Retrieves all payer accounts linked to the organization, including their status and associated segments.
GET
/v1/managements/accounts/status
POST
/v1/managements/accounts/{companyId}
GET
/v1/managements/billinggroups
GET
/v1/managements/billinggroups/status
POST
/v1/managements/billinggroups/terms:accept
POST
/v1/managements/billinggroups/{companyId}
GET
/v1/metrics
WORK-IN-PROGRESS: Do not use. Retrieves key performance metrics for cloud commitments.
POST
/v1/onboarding
WORK-IN-PROGRESS: Registers a new child organization under the channel partner. Creates the organization, sets up user memberships, and establishes the partnership relationship.
POST
/v1/onboarding/aws/cftemplate/guaranteed
CreateGuaranteedCommitmentAccess verifies and registers a deployed guaranteed CloudFormation stack.
GET
/v1/onboarding/aws/cftemplate/guaranteed:url
GetGuaranteedCommitmentTemplateUrl returns a CloudFormation launch URL for deploying both Alphaus (Ripple) and Archera IAM roles in a single stack.
GET
/v1/onboarding/aws/cloudformation/launchstackurl
WORK-IN-PROGRESS: Generates AWS CloudFormation launch stack URL. Creates a pre-configured URL to deploy the CloudFormation stack in the AWS console.
GET
/v1/onboarding/aws/cloudformation/template
WORK-IN-PROGRESS: Generates CloudFormation template for AWS integration. Creates the necessary IAM role and policy template for setting up AWS access.
GET
/v1/onboarding/aws/privateoffer/{payerAccountId}
Retrieves the AWS Marketplace private offer details for a payer account. Used by the onboarding "Accept Private Offer" step.
POST
/v1/onboarding/aws/start
WORK-IN-PROGRESS: Starts the onboarding process for an organization. Creates or retrieves an onboarding record and sets the provider to AWS.
POST
/v1/onboarding/aws/verify
WORK-IN-PROGRESS: Runs AWS onboarding verification process. Creates a new CUR or uses an existing CUR and verifies AWS integration setup and returns validation status for all required features.
POST
/v1/onboarding/azure/integration
WORK-IN-PROGRESS: Creates the Azure cloud integration after all onboarding steps complete.
GET
/v1/onboarding/azure/integrations
WORK-IN-PROGRESS: Lists Azure integrations to verify onboarding completion.
POST
/v1/onboarding/azure/start
WORK-IN-PROGRESS: Starts the Azure onboarding process. Creates an onboarding record in Archera for the given org and returns the onboardingId. Stores the Ripple billingGroupId/companyId association f…
GET
/v1/onboarding/azure/{onboardingId}/accounts
WORK-IN-PROGRESS: Lists the available Azure subscriptions or billing accounts for the user to select during onboarding.
GET
/v1/onboarding/azure/{onboardingId}/authurl
WORK-IN-PROGRESS: Returns the Azure OAuth URL the user must visit to authorize Archera.
POST
/v1/onboarding/azure/{onboardingId}/validate
WORK-IN-PROGRESS: Validates that the Azure app was installed and the user authorized it.
POST
/v1/onboarding/azure/{onboardingId}:update
WORK-IN-PROGRESS: Updates the Azure onboarding record.
POST
/v1/onboarding/billinggroup:validate
POST
/v1/onboarding/status:read
WORK-IN-PROGRESS: Retrieves the latest onboarding status for: - an MSP - a company under an MSP - a payer account under an MSP
POST
/v1/organizations:read
WORK-IN-PROGRESS: List all the registered orgs
POST
/v1/reports/invoice/{month}/accounts:read
Reads per-account commitment report details for a specific month. Only available in Ripple.
POST
/v1/reports/invoice:read
Reads monthly commitment reports for the MSP. Only available in Ripple.
GET
/v1/resources
WORK-IN-PROGRESS: Do not use. Retrieves a list of infrastructure resources for the organization.
GET
/v1/resources/{resourceId}/dailyusage
WORK-IN-PROGRESS: Do not use. Retrieves daily usage data for a specific resource within the specified date range.
Schemas 101
The contract defines 101 schemas that model the data the API accepts and returns. The most detailed are v1ReservableResource (77 properties), v1DefaultPurchasePlan (57 properties), blueapiGcV1Resource (45 properties), v1Commitment (44 properties). Each schema is shown below with its type and property counts.
v1StartAwsOnboardingResponse
object
1 property
GuaranteedCommitmentsSaveCommitmentsPlanAsDraftBody
object
33 properties
v1AwsExistingCur
object
4 properties
v1RegisterOrgRequest
object
8 properties
v1AzureIntegration
object
AzureIntegration is the full Azure cloud integration record from Archera.
23 properties
v1ListAzureIntegrationsResponse
object
ListAzureIntegrationsResponse contains all Azure integrations for the org (Step 9).
1 property
v1ListOrgsRequest
object
v1RegisterOrgResponse
object
8 properties
v1ListResourcesResponse
object
1 property
v1GetAzureOnboardingAuthUrlResponse
object
GetAzureOnboardingAuthUrlResponse contains the OAuth URL (Step 4).
1 property
v1AzureAccount
object
AzureAccount is one available subscription or billing account (Step 6).
5 properties
v1Segment
object
5 properties
GuaranteedCommitmentsSetBillingGroupStatusBody
object
2 properties
blueapiGcV1Resource
object
45 properties
v1CommitmentReport
object
9 properties
v1DeleteDraftPurchasePlanResponse
object
2 properties
v1StartAzureOnboardingResponse
object
StartAzureOnboardingResponse is returned from StartAzureOnboarding.
4 properties
v1CommitmentReportAccount
object
10 properties
v1ResourceDailyUsage
object
16 properties
v1AggregateMetrics
object
3 properties
v1Membership
object
2 properties
ListPayerAccountsResponsePayerAccountStatus
string
GuaranteedCommitmentsUpdateAzureOnboardingBody
object
22 properties
GetOnboardingStatusResponseOnboardingStatus
string
v1TermsAcceptance
object
TermsAcceptance represents the current terms acceptance state for an entity.
3 properties
v1Commitment
object
44 properties
v1GetGuaranteedCommitmentTemplateUrlResponse
object
7 properties
v1SetBillingGroupStatusResponse
object
1 property
v1AzureOnboardingCreatedBy
object
AzureOnboardingCreatedBy identifies who triggered the onboarding.
3 properties
v1AcceptBillingGroupTermsResponse
object
1 property
v1ListBillingGroupsResponseBillingGroup
object
11 properties
v1AzureIntegrationFeatureStatus
object
AzureIntegrationFeatureStatus is a single feature check for an Azure integration (Step 9).
3 properties
v1ServiceSummary
object
16 properties
v1AzureIntegrationOnboarding
object
AzureIntegrationOnboarding is a summary of the onboarding linked to an integration.
7 properties
v1GetOnboardingStatusResponse
object
11 properties
v1VerifyAwsOnboardingResponse
object
1 property
v1ListDraftPurchasePlansResponse
object
1 property
v1CreateGuaranteedCommitmentAccessRequest
object
2 properties
rpcStatus
object
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](h…
3 properties
GuaranteedCommitmentsReadCommitmentReportAccountsBody
object
v1ContractSpec
object
4 properties
v1DefaultPurchasePlan
object
57 properties
v1GetUpdatedPurchasePlansBySegmentRequest
object
v1VerifyAwsOnboardingRequest
object
6 properties
gcV1Org
object
3 properties
GuaranteedCommitmentsValidateAzureAppInstallBody
object
21 properties
v1GetResourceDailyUsageResponse
object
1 property
v1GetAwsCloudFormationTemplateResponse
object
1 property
GuaranteedCommitmentsSetPayerAccountEnabledBody
object
1 property
v1CreateGuaranteedCommitmentAccessResponse
object
11 properties
v1CommitmentPlanDetails
object
25 properties
v1PlanHistoryEntry
object
10 properties
v1AcceptBillingGroupTermsRequest
object
AwsOnboardingFeatureCheckAwsOnboardingFeatureStatus
string
v1Address
object
6 properties
v1ListReservableResourcesResponse
object
1 property
v1AzureArcheraOrg
object
AzureArcheraOrg is the full Archera org object. Received from StartAzureOnboarding response and must be echoed back verbatim on every UpdateAzureOnboarding and…
38 properties
v1AzureArcheraOrgLeaseBudget
object
AzureArcheraOrgLeaseBudget is the lease budget config within the Archera org object.
3 properties
ListBillingGroupsResponseBillingGroupStatus
string
v1CommitmentPlanLineItem
object
33 properties
v1SetPayerAccountEnabledResponse
object
1 property
v1PlanSummary
object
15 properties
v1ListBillingGroupsResponse
object
1 property
VerifyAwsOnboardingResponseAwsOnboardingFeatureCheck
object
2 properties
v1GetUpdatedPurchasePlansBySegmentResponse
object
1 property
v1CommitmentsUtilizationResponse
object
1 property
v1GetAwsLaunchStackUrlResponse
object
1 property
v1MetricsResponse
object
16 properties
v1OrgUser
object
2 properties
v1CreateAzureIntegrationRequest
object
CreateAzureIntegrationRequest creates the final Azure integration (Step 8). Ripple fields are stored alongside Archera integration data to link the Azure tenan…
18 properties
v1GetOnboardingStatusRequest
object
3 properties
v1CommitmentPlanResourceMatch
object
27 properties
v1ListAzureOnboardingAccountsResponse
object
ListAzureOnboardingAccountsResponse returns accounts the user can select.
1 property
v1ReadCommitmentReportsRequest
object
v1GetPayerAccountStatusResponse
object
1 property
protobufAny
object
Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides supp…
1 property
v1CommitmentsChartResponse
object
1 property
v1CommitmentsUtilizationData
object
10 properties
v1GetAwsPrivateOfferResponse
object
9 properties
v1PayerAccountDetails
object
8 properties
v1Provider
string
v1ValidateBillingGroupResponse
object
4 properties
GuaranteedCommitmentsCommitmentsPlanApplyBody
object
v1ListCommitmentsResponse
object
1 property
v1ListPurchasePlansBySegmentResponse
object
1 property
v1ReservableResource
object
ReservableResource is a fully-detailed infrastructure resource returned by ListReservableResources. It extends the basic resource shape with usage metrics, dai…
77 properties
v1StartAwsOnboardingRequest
object
5 properties
v1CreateAzureIntegrationResponse
object
CreateAzureIntegrationResponse is returned after creating the Azure integration (Step 8). A "tenantalreadyconnected" errorcode is treated as success.
7 properties
v1CommitmentsChartData
object
3 properties
v1CreateCustomCommitmentPlanRequest
object
CreateCustomCommitmentPlanRequest creates a new top-down custom commitment plan.
11 properties
v1PlanHistoryUser
object
3 properties
ListPayerAccountsResponsePayerAccount
object
8 properties
v1GetBillingGroupStatusResponse
object
2 properties
v1AzureArcheraOrgFeatureStatus
object
AzureArcheraOrgFeatureStatus is a single feature status entry within the Archera org object.
4 properties
v1StartAzureOnboardingRequest
object
StartAzureOnboardingRequest initiates Azure onboarding (Step 1). Ripple fields are required to link this Azure tenant to the correct Ripple billing group and c…
5 properties
v1GetAvailableCommitmentTypesResponse
object
1 property
v1ValidateBillingGroupRequest
object
2 properties
v1ListPayerAccountsResponse
object
2 properties
v1AzureOnboardingState
object
AzureOnboardingState is the full Archera onboarding record state. Returned by StartAzureOnboarding, UpdateAzureOnboarding, ValidateAzureAppInstall.
27 properties
v1CreateCustomCommitmentPlanResponse
object
1 property
v1GetPurchasePlansDetailsResponse
object
4 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Alphaus 12
Other APIs Alphaus publishes across the network.
Alphaus Admin API
Alphaus Billing API
Alphaus Cost API
Alphaus Cover API
Alphaus Flags API
Alphaus Flow API
Alphaus Iam API
Alphaus Luster API
Alphaus Operations API
Alphaus Organization API
Alphaus Preferences API
Alphaus Pricing API
#GuaranteedCommitments
Where this information came from
This is an independent, third-party profile of Alphaus GuaranteedCommitments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.