API Reference

PaginationMetadata

Properties related to pagination for API responses.

ApiErrorResponse

Returns error details when an API request fails.

UserInvite

Parameters for inviting users to an organization.

MutateAddress

Description of an API call to mutate or change a user's address.

RegisterOrg

Functionality for registering a new organization.

OrgMembershipResponse

Response structure for organization membership queries.

RegisterOrgResponse

Returns information about the result of an organization registration request.

InviteUsers

APIs to invite users to a particular organization.

CloudFormation

Details related to AWS CloudFormation resources.

LaunchStackUrls

Provides URLs for launching AWS CloudFormation stacks.

ExistingCUR

Retrieves existing Customer Usage Reports.

VerificationArgs

Arguments required for verifying user details.

Validation

Validates input data before processing.

AzureAuthUrlArgs

Parameters for Azure authentication URL generation.

AzureAuthUrlResponse

Response structure for Azure authentication URL requests.

PartnerRegisterOrg

Functionality for partner organizations to register.

PartnerRegisterOrgResponse

Supports the response for partner organization registration.

StartOnboarding

Initiates the onboarding process for new users.

ListChildOrgsResponse

Response that lists child organizations under a parent organization.

PurchasePlanContractSpec

Details needed for specifying a purchase plan contract.

MetaPlanInfo

Information related to the metadata of plans.

UserInfo

Retrieves user information based on specific criteria.

PlanInfo

Provides details related to various plans.

ExecutePurchasePolicyDump_Exclude_Segment_TargetPlan

API for executing purchase policy dumps excluding segments and target plans.

SegmentInfo

Details on segments associated with various plans or products.

PurchasePlanV2NameId

Structure for identifying purchase plan names and IDs.

PurchaseAction_Exclude_User

APIs to handle purchase actions excluding specific users.

RenewalPurchaseAction_Exclude_User

Functionality for handling renewal purchases excluding certain users.

ExchangeAction_Exclude_User

APIs for exchange actions while excluding specific users.

LegacyPurchaseAction_Exclude_User

Handles legacy purchase actions for the system.

FlaggedAction

Information on actions that have been flagged for review.

CommitmentSummary

Summary of commitments made within the organization.

AggregateMetrics

Consolidates various metrics for analysis.

LineItemSummary

Summarizes line items in a purchase or transaction.

PurchasePlanV2CombinedSummary

Combines summaries of purchase plans into a single view.

PurchaseRequest

Structure of a purchase request.

PurchasePlanV2

Detailed structure of the new version of purchase plans.

UpdatePartnerOrg

APIs related to updating information for partner organizations.

PartnerOrgResponse

Response structure for queries about partner organizations.