swagger: '2.0' info: title: Blue API reference Admin Billing API description: 'Alphaus provides an API for interacting with its services. Blue API is a RESTful API that can be accessed by an HTTP client such as `curl`, or any HTTP library which is part of most modern programming languages. This API reference is autogenerated from [protocol buffers](https://developers.google.com/protocol-buffers) defined in this [repository](https://github.com/alphauslabs/blueapi), together with our supported [client libraries](https://alphauslabs.github.io/docs/blueapi/client-sdks/). See the official [documentation](https://alphauslabs.github.io/docs/blueapi/overview/) for more information. You may encounter the following feature maturity indicators: - **(WORK-IN-PROGRESS)** - Development is ongoing, don''t use yet; - **(BETA)** - New or experimental features, subject to changes; and - **(DEPRECATED)** - Outdated or replaced features. Some endpoints, especially those that return lists of resources, have streaming responses; newline-separated stream of “chunks”. Each chunk is an envelope that can contain either a response message or an error. Only the last chunk will include an error, if any.' version: v1 host: api.alphaus.cloud basePath: /m/blue schemes: - https consumes: - application/json produces: - application/json tags: - name: Billing description: '(BETA) Billing API. Base URL: https://api.alphaus.cloud/m/blue/billing' externalDocs: description: Service definition url: https://github.com/alphauslabs/blueapi/tree/main/billing/ paths: /billing/v1/reseller/announcements/{announcementId}: get: summary: Gets the announcement list. operationId: Billing_GetAnnouncements responses: '200': description: A successful response.(streaming responses) schema: type: object properties: result: $ref: '#/definitions/v1Announcement' error: $ref: '#/definitions/rpcStatus' title: Stream result of v1Announcement default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: announcementId description: Optional. Set empty to return all in: path required: true type: string tags: - Billing /v1/accessgroups: get: summary: Lists access group. Only available in Ripple. operationId: Billing_ListAccessGroups responses: '200': description: A successful response.(streaming responses) schema: type: object properties: result: $ref: '#/definitions/apiRippleAccessGroup' error: $ref: '#/definitions/rpcStatus' title: Stream result of apiRippleAccessGroup default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: fieldMask description: 'Optional. Get only the value that set fieldMask. see more info: https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/field_mask.proto' in: query required: false type: string tags: - Billing post: summary: Registers the access group. Only available in Ripple. operationId: Billing_CreateAccessGroup responses: '200': description: A successful response. schema: $ref: '#/definitions/apiRippleAccessGroup' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: body description: Request message for the CreateAccessGroup rpc. in: body required: true schema: $ref: '#/definitions/v1CreateAccessGroupRequest' tags: - Billing /v1/accessgroups/{accessGroupId}: get: summary: 'WORK-IN-PROGRESS: Gets an access group.' operationId: Billing_GetAccessGroup responses: '200': description: A successful response. schema: $ref: '#/definitions/v1GetAccessGroupResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: accessGroupId in: path required: true type: string - name: fieldMask description: 'Optional. Get only the value that set fieldMask. see more info: https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/field_mask.proto' in: query required: false type: string tags: - Billing /v1/accessgroups/{id}: delete: summary: Deletes the access group. Only available in Ripple. operationId: Billing_DeleteAccessGroup responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: id description: Required. access group id. in: path required: true type: string tags: - Billing put: summary: Updates the access group. Only available in Ripple. operationId: Billing_UpdateAccessGroup responses: '200': description: A successful response. schema: $ref: '#/definitions/apiRippleAccessGroup' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: id description: Required. access group id. in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingUpdateAccessGroupBody' tags: - Billing /v1/adjustmentconfig/{vendor}: get: summary: Gets adjustment config operationId: Billing_GetAdjustmentConfig responses: '200': description: A successful response. schema: $ref: '#/definitions/apiAdjustmentConfig' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: vendor description: Required. At the moment, only `aws` is supported. in: path required: true type: string - name: includeSPPDiscount in: query required: false type: boolean tags: - Billing delete: summary: Deletes adjustment config operationId: Billing_DeleteAdjustmentConfig responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: vendor description: Required. At the moment, only `aws` is supported. in: path required: true type: string tags: - Billing post: summary: Creates adjustment config description: "[ERRORS] \n- InvalidArgument:\n - the AdjustmentConfig is already exists.\n- NotFound:\n - the AdjustmentConfig is not found." operationId: Billing_CreateAdjustmentConfig responses: '200': description: A successful response. schema: $ref: '#/definitions/apiAdjustmentConfig' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: vendor description: Required. At the moment, only `aws` is supported. in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingCreateAdjustmentConfigBody' tags: - Billing put: summary: Updates adjustment config operationId: Billing_UpdateAdjustmentConfig responses: '200': description: A successful response. schema: $ref: '#/definitions/apiAdjustmentConfig' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: vendor description: Required. At the moment, only `aws` is supported. in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingUpdateAdjustmentConfigBody' tags: - Billing /v1/aws/dailyrunhistory:read: post: summary: Reads the daily calculation history of all accounts in your billing groups. Only available in Ripple. operationId: Billing_ListAwsDailyRunHistory responses: '200': description: A successful response.(streaming responses) schema: type: object properties: result: $ref: '#/definitions/v1AwsDailyRunHistory' error: $ref: '#/definitions/rpcStatus' title: Stream result of v1AwsDailyRunHistory default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: body description: Request message for the Billing.ListAwsCalculationHistory rpc. in: body required: true schema: $ref: '#/definitions/v1ListAwsDailyRunHistoryRequest' tags: - Billing /v1/billinggroup/account: post: summary: Add a vendor account to a billing group. operationId: Billing_AddAccountToBillingGroup responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: body in: body required: true schema: $ref: '#/definitions/v1AddAccountToBillingGroupRequest' tags: - Billing /v1/billinggroup/customfield: post: summary: Add a custom field into a billing group operationId: Billing_AddBillingGroupCustomField responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: body in: body required: true schema: $ref: '#/definitions/v1AddBillingGroupCustomFieldRequest' tags: - Billing /v1/billinggroup/customfield/{groupId}/{customFieldId}: delete: summary: Remove a custom field from a billing group operationId: Billing_DeleteBillingGroupCustomField responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: groupId description: Required. Billing group internal Id in: path required: true type: string - name: customFieldId description: Required. The id of customfield from get customfield in: path required: true type: string tags: - Billing /v1/billinggroup/customfield:read: post: summary: Show all the billing groups custom fields operationId: Billing_ListBillingGroupCustomField responses: '200': description: A successful response.(streaming responses) schema: type: object properties: result: $ref: '#/definitions/v1ListBillingGroupCustomFieldResponse' error: $ref: '#/definitions/rpcStatus' title: Stream result of v1ListBillingGroupCustomFieldResponse default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: body in: body required: true schema: $ref: '#/definitions/v1ListBillingGroupCustomFieldRequest' tags: - Billing /v1/billinggroup/reseller/announcements/{groupId}: get: summary: Gets the announcement list for billing group operationId: Billing_GetBillingGroupAnnouncements responses: '200': description: A successful response.(streaming responses) schema: type: object properties: result: $ref: '#/definitions/v1GetBillingGroupAnnouncementsResponse' error: $ref: '#/definitions/rpcStatus' title: Stream result of v1GetBillingGroupAnnouncementsResponse default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: groupId description: Optional. Set empty to return all in: path required: true type: string tags: - Billing /v1/billinggroup/tags: post: summary: Add Tags to the billing group operationId: Billing_AddTagsToBillingGroup responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: body in: body required: true schema: $ref: '#/definitions/v1AddTagsToBillingGroupRequest' tags: - Billing /v1/billinggroup/{id}: delete: summary: Delete a billing group. operationId: Billing_DeleteBillinGroup responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: id in: path required: true type: string tags: - Billing /v1/billinggroup/{id}/{vendor}/supportplan: get: summary: 'WORK-IN-PROGRESS: Gets the account support plan in billing group. Only available in Ripple.' operationId: Billing_GetBillingGroupAccountSupportPlan responses: '200': description: A successful response. schema: $ref: '#/definitions/v1GetBillingGroupAccountSupportPlanResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: id description: Required. The billing internal id. in: path required: true type: string - name: vendor description: Required. At the moment, `aws` is supported. in: path required: true type: string tags: - Billing put: summary: 'WORK-IN-PROGRESS: Updates the account support plan in billing group. Only available in Ripple.' operationId: Billing_UpdateBillingGroupAccountSupportPlan responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: id description: Required. The billing internal id. in: path required: true type: string - name: vendor description: Required. At the moment, `aws` is supported. in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingUpdateBillingGroupAccountSupportPlanBody' tags: - Billing /v1/billinggroup/{id}/{vendor}/untaggedgroups: post: summary: Sets non-tag group settings for a billing group. operationId: Billing_UpdateNonTagGroupToBillingGroup responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: id description: Required. The billing group's internal id in: path required: true type: string - name: vendor description: Required. The vendor (aws, azure, etc) in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingUpdateNonTagGroupToBillingGroupBody' tags: - Billing /v1/billinggroup/{id}:additionalCharges: put: summary: 'WORK-IN-PROGRESS: Update additonal charges for a billing group' operationId: Billing_UpdateBillingGroupAdditionalCharges responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: id in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingUpdateBillingGroupAdditionalChargesBody' tags: - Billing /v1/billinggroup/{id}:basicInfo: put: summary: Update billing group basic information operationId: Billing_UpdateBillingGroupBasicInformation responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: id in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingUpdateBillingGroupBasicInformationBody' tags: - Billing /v1/billinggroup/{id}:customFields: put: summary: 'WORK-IN-PROGRESS: Update billing group custom fields information' operationId: Billing_UpdateBillingGroupCustomFields responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: id in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingUpdateBillingGroupCustomFieldsBody' tags: - Billing /v1/billinggroup/{id}:freeFormat: put: summary: 'WORK-IN-PROGRESS: Update billing group custom fields information' operationId: Billing_UpdateBillingGroupFreeFormat responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: id in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingUpdateBillingGroupFreeFormatBody' tags: - Billing /v1/billinggroup/{id}:invoiceSettings: put: summary: 'WORK-IN-PROGRESS: Update invoice settings for a billing group' operationId: Billing_UpdateBillingGroupInvoiceSettings responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: id in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingUpdateBillingGroupInvoiceSettingsBody' tags: - Billing /v1/billinggroup/{id}:resellerCharges: put: summary: 'WORK-IN-PROGRESS: Update reseller charges for a billing group' operationId: Billing_UpdateBillingGroupResellerCharges responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: id in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingUpdateBillingGroupResellerChargesBody' tags: - Billing /v1/billinggroup/{id}:resources: put: summary: 'WORK-IN-PROGRESS: Update linked resources for a billing group' operationId: Billing_UpdateBillingGroupLinkedResources responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: id in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingUpdateBillingGroupLinkedResourcesBody' tags: - Billing /v1/billinggroups: get: summary: Lists all billing groups (streamed). operationId: Billing_ListBillingGroups responses: '200': description: A successful response.(streaming responses) schema: type: object properties: result: $ref: '#/definitions/billingV1BillingGroup' error: $ref: '#/definitions/rpcStatus' title: Stream result of billingV1BillingGroup default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: fieldMask description: 'Optional. Get only the value that set fieldMask. see more info: https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/field_mask.proto' in: query required: false type: string - name: vendors description: 'Optional. Filter vendor accounts included in BillingGroup. Format: vendors=vendor1,vendor2,vendor3. For example, When Aws and Gcp to be filtered vendors=aws,gcp If you want to get all vendors, not set parameter.' in: query required: false type: string - name: calcType description: 'Optional. Filter by calcType. Format: calType=account Valid values: account, tag' in: query required: false type: string - name: displayCost description: 'Optional. Filter by displayCost. Format: displayCost=unblended_cost valid values: unblended_cost, true_unblended_cost' in: query required: false type: string - name: bgType description: 'Optional. For aws only, filter will be ignored for other vendors. Valid values: default, imported' in: query required: false type: string tags: - Billing post: summary: Registers a billing group. operationId: Billing_CreateBillingGroup responses: '200': description: A successful response. schema: $ref: '#/definitions/billingV1BillingGroup' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: body description: Request message for the Billing.CreateBillingGroup rpc. in: body required: true schema: $ref: '#/definitions/v1CreateBillingGroupRequest' tags: - Billing /v1/billinggroups/billingconductor/{id}: get: summary: 'WORK-IN-PROGRESS: Gets all Billing Groups in AWS Billing Conductor(ABC) for specific payer id.' operationId: Billing_ListAbcBillingGroups responses: '200': description: A successful response.(streaming responses) schema: type: object properties: result: $ref: '#/definitions/v1AbcBillingGroup' error: $ref: '#/definitions/rpcStatus' title: Stream result of v1AbcBillingGroup default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: id description: Required. Payer Id. in: path required: true type: string tags: - Billing /v1/billinggroups/billingconductor/{payerId}/accounts: get: summary: 'WORK-IN-PROGRESS: Gets all accounts associated to AWS Billing Conductor(ABC) Billing group' operationId: Billing_ListAbcBillingGroupAccounts responses: '200': description: A successful response.(streaming responses) schema: type: object properties: result: $ref: '#/definitions/v1AbcAccount' error: $ref: '#/definitions/rpcStatus' title: Stream result of v1AbcAccount default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: payerId description: Required. Payer Id. in: path required: true type: string - name: billingGroupArn description: Required. BillingGroup Id. in: query required: false type: string tags: - Billing /v1/billinggroups/children: post: summary: Creates a child billing group under a parent billing group operationId: Billing_CreateChildBillingGroup responses: '200': description: A successful response. schema: $ref: '#/definitions/v1CreateChildBillingGroupResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: body in: body required: true schema: $ref: '#/definitions/v1CreateChildBillingGroupRequest' tags: - Billing /v1/billinggroups/children/{internalId}: get: summary: Gets child billing group info operationId: Billing_GetChildBillingGroup responses: '200': description: A successful response. schema: $ref: '#/definitions/v1GetChildBillingGroupResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: internalId description: Required. Internal Id in: path required: true type: string tags: - Billing delete: summary: Deletes all child billing group info operationId: Billing_DeleteChildBillingGroup responses: '200': description: A successful response. schema: $ref: '#/definitions/v1DeleteChildBillingGroupResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: internalId description: Required. Child billing group's internal Id in: path required: true type: string tags: - Billing put: summary: Updates child billing group's basic info operationId: Billing_UpdateChildBillingGroup responses: '200': description: A successful response. schema: $ref: '#/definitions/v1UpdateChildBillingGroupResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: internalId description: Required. Internal Id in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingUpdateChildBillingGroupBody' tags: - Billing /v1/billinggroups/children/{internalId}/invoiceSettings: put: summary: Updates child billing group's invoice settings operationId: Billing_UpdateChildBillingGroupInvoiceSettings responses: '200': description: A successful response. schema: $ref: '#/definitions/v1UpdateChildBillingGroupInvoiceSettingsResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: internalId description: Required. Internal Id in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingUpdateChildBillingGroupInvoiceSettingsBody' tags: - Billing /v1/billinggroups/children/{internalId}/serviceDiscounts: get: summary: Returns the service discount associated with the billing group id operationId: Billing_GetChildBillingGroupInvoiceServiceDiscounts responses: '200': description: A successful response. schema: $ref: '#/definitions/v1GetChildBillingGroupInvoiceServiceDiscountsResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: internalId description: Required. Child Billing Group Internal Id in: path required: true type: string tags: - Billing post: summary: Sets the child billing group invoice service discounts. Only available in Ripple. operationId: Billing_SetChildBillingGroupInvoiceServiceDiscounts responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: internalId description: Required. Internal Id of the child billing group. in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingSetChildBillingGroupInvoiceServiceDiscountsBody' tags: - Billing /v1/billinggroups/children/{internalId}/serviceDiscounts/accounts:read: get: summary: Returns the account's service discounts associated with the child billing group id operationId: Billing_ReadChildBillingGroupAccountInvoiceServiceDiscounts responses: '200': description: A successful response.(streaming responses) schema: type: object properties: result: $ref: '#/definitions/v1AccountInvoiceServiceDiscounts' error: $ref: '#/definitions/rpcStatus' title: Stream result of v1AccountInvoiceServiceDiscounts default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: internalId description: Required. Child Billing Group Internal Id in: path required: true type: string tags: - Billing /v1/billinggroups/children/{internalId}/serviceDiscounts/accounts:set: post: summary: Sets the child billing group's account invoice service discounts. Only available in Ripple. operationId: Billing_SetChildBillingGroupAccountInvoiceServiceDiscounts responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: internalId description: Required. child billing group's internal Id. in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingSetChildBillingGroupAccountInvoiceServiceDiscountsBody' tags: - Billing /v1/billinggroups/children:read: post: summary: Lists child billing groups under a specific filter operationId: Billing_ReadChildBillingGroups responses: '200': description: A successful response.(streaming responses) schema: type: object properties: result: $ref: '#/definitions/v1ChildBillingGroup' error: $ref: '#/definitions/rpcStatus' title: Stream result of v1ChildBillingGroup default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: body in: body required: true schema: $ref: '#/definitions/v1ReadChildBillingGroupsRequest' tags: - Billing /v1/billinggroups/exclude-service-settings: get: summary: List Exclude Service Entries operationId: Billing_ListExcludeServices responses: '200': description: A successful response. schema: $ref: '#/definitions/v1ListExcludeServicesResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: mspId description: MSP (Managed Service Provider) ID. Partition key for the exclude service entries. in: query required: false type: string - name: vendor description: Cloud vendor (e.g., "aws", "gcp"). If empty, returns all vendors for the MSP. in: query required: false type: string tags: - Billing delete: summary: Delete Exclude Service Entry operationId: Billing_DeleteExcludeServiceEntry responses: '200': description: A successful response. schema: $ref: '#/definitions/v1DeleteExcludeServiceEntryResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: mspId description: MSP (Managed Service Provider) ID. Partition key for the exclude service entry. in: query required: false type: string - name: vendor description: Cloud vendor (e.g., "aws", "gcp"). in: query required: false type: string - name: payerId description: Payer/account ID to delete. Use "all" or "*" to apply to all accounts. in: query required: false type: string - name: service description: Cloud service name (e.g., "EC2", "BigQuery"). in: query required: false type: string - name: product description: Product or SKU code (used for GCP or detailed exclusions). in: query required: false type: string tags: - Billing post: summary: Create Exclude Service Entry operationId: Billing_CreateExcludeServiceEntry responses: '200': description: A successful response. schema: $ref: '#/definitions/v1CreateExcludeServiceEntryResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: body in: body required: true schema: $ref: '#/definitions/v1CreateExcludeServiceEntryRequest' tags: - Billing put: summary: Update Exclude Service Entry operationId: Billing_UpdateExcludeServiceEntry responses: '200': description: A successful response. schema: $ref: '#/definitions/v1UpdateExcludeServiceEntryResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: body in: body required: true schema: $ref: '#/definitions/v1UpdateExcludeServiceEntryRequest' tags: - Billing /v1/billinggroups/merged: post: summary: Registers a billing group with Merged Endpoints. Only available in Ripple. WORK IN PROGRESS operationId: Billing_CreateBillingGroupMerged responses: '200': description: A successful response. schema: $ref: '#/definitions/billingV1BillingGroup' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: body description: Request message for the CreateBillingGroupMerged rpc. in: body required: true schema: $ref: '#/definitions/v1CreateBillingGroupMergedRequest' tags: - Billing /v1/billinggroups/{billingInternalId}: get: summary: Gets a billing group. operationId: Billing_GetBillingGroup responses: '200': description: A successful response. schema: $ref: '#/definitions/v1GetBillingGroupResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: billingInternalId in: path required: true type: string - name: fieldMask description: 'Optional. Get only the value that set fieldMask. see more info: https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/field_mask.proto' in: query required: false type: string tags: - Billing /v1/billinggroups/{id}/invoicelayoutconfig: get: summary: WORK-IN-PROGRESS. Gets the billing group invoice layout configs, used for overriding MSP level configs. operationId: Billing_GetBillingGroupInvoiceLayoutConfig responses: '200': description: A successful response. schema: $ref: '#/definitions/v1GetBillingGroupInvoiceLayoutConfigResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: id description: Required. The billing group internal id. in: path required: true type: string tags: - Billing delete: summary: WORK-IN-PROGRESS. Unsets the billing group invoice layout config. operationId: Billing_DeleteBillingGroupInvoiceLayoutConfig responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: id description: Required. The billing group internal id. in: path required: true type: string tags: - Billing post: summary: WORK-IN-PROGRESS. Sets the billing group invoice layout configs. operationId: Billing_SetBillingGroupInvoiceLayoutConfig responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: id description: Required. The billing group internal id. in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingSetBillingGroupInvoiceLayoutConfigBody' tags: - Billing /v1/billinggroups/{id}/invoicetemplate: post: summary: Creates/Updates a billing group's invoice template. Only available in Ripple. operationId: Billing_UpdateBillingGroupInvoiceTemplate responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: id description: Required. The billing internal ID in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingUpdateBillingGroupInvoiceTemplateBody' tags: - Billing /v1/billinggroups:bulkCreate: post: summary: 'Create billing group in bulk from CSV file. Returns a long-running operation. Poll status via the Operations service (GET /ops/v1/{name}).' operationId: Billing_BulkCreateBillingGroup responses: '200': description: A successful response. schema: $ref: '#/definitions/protosOperation' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: body in: body required: true schema: $ref: '#/definitions/v1BulkCreateBillingGroupRequest' tags: - Billing /v1/billinggroups:bulkLinkAccount: post: summary: 'Link accounts to a billing group in bulk from a CSV file. Returns a long-running operation. Poll status via the Operations service (GET /ops/v1/{name}).' operationId: Billing_BulkLinkAccount responses: '200': description: A successful response. schema: $ref: '#/definitions/protosOperation' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: body in: body required: true schema: $ref: '#/definitions/v1BulkLinkAccountRequest' tags: - Billing /v1/billinggroups:bulkTag: post: summary: 'Bulk-tag multiple billing groups from a CSV file. Supports add, delete, and dry-run modes. Returns a long-running operation. Poll status via the Operations service (GET /ops/v1/{name}).' operationId: Billing_BulkTagBillingGroup responses: '200': description: A successful response. schema: $ref: '#/definitions/protosOperation' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: body description: Request for BulkTagBillingGroup. in: body required: true schema: $ref: '#/definitions/v1BulkTagBillingGroupRequest' tags: - Billing /v1/billinggroups:paginated: get: summary: Lists all billing groups with pagination support. operationId: Billing_ListBillingGroupsPaginated responses: '200': description: A successful response. schema: $ref: '#/definitions/v1ListBillingGroupsPaginatedResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: fieldMask description: 'Optional. Get only the value that set fieldMask. see more info: https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/field_mask.proto' in: query required: false type: string - name: vendors description: 'Optional. Filter vendor accounts included in BillingGroup. Format: vendors=vendor1,vendor2,vendor3. For example, When Aws and Gcp to be filtered vendors=aws,gcp If you want to get all vendors, not set parameter.' in: query required: false type: string - name: calcType description: 'Optional. Filter by calcType. Format: calType=account Valid values: account, tag' in: query required: false type: string - name: displayCost description: 'Optional. Filter by displayCost. Format: displayCost=unblended_cost valid values: unblended_cost, true_unblended_cost' in: query required: false type: string - name: bgType description: 'Optional. For aws only, filter will be ignored for other vendors. Valid values: default, imported' in: query required: false type: string - name: companyName description: Optional. Filter by company name. in: query required: false type: string - name: billingGroupName description: Optional. Filter by billing group name. in: query required: false type: string - name: billingGroupId description: Optional. Filter by billing group id. in: query required: false type: string - name: pageSize description: Optional. Page size for pagination. Default is 50, maximum is 1000. in: query required: false type: integer format: int32 - name: pageNumber description: Optional. Page number for pagination. Starts from 1. Default is 1. in: query required: false type: integer format: int32 tags: - Billing /v1/credits: get: summary: Gets the credits operationId: Billing_GetCredits responses: '200': description: A successful response.(streaming responses) schema: type: object properties: result: $ref: '#/definitions/v1Credit' error: $ref: '#/definitions/rpcStatus' title: Stream result of v1Credit default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' tags: - Billing /v1/csvsettings: get: summary: Gets the csv column settings operationId: Billing_GetCsvSettings responses: '200': description: A successful response.(streaming responses) schema: type: object properties: result: $ref: '#/definitions/v1CsvSetting' error: $ref: '#/definitions/rpcStatus' title: Stream result of v1CsvSetting default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' tags: - Billing /v1/customfield: post: summary: Creates new customfield operationId: Billing_CreateCustomField responses: '200': description: A successful response. schema: $ref: '#/definitions/v1CustomField' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: body in: body required: true schema: $ref: '#/definitions/v1CreateCustomFieldRequest' tags: - Billing /v1/customfield/{id}: delete: summary: Deletes the customfield operationId: Billing_DeleteCustomField responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: id in: path required: true type: string tags: - Billing put: summary: Update the `customField` specified id, modifying its key and description operationId: Billing_UpdateCustomField responses: '200': description: A successful response. schema: $ref: '#/definitions/v1CustomField' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: id in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingUpdateCustomFieldBody' tags: - Billing /v1/customfield:read: post: summary: Returns all registered customfields operationId: Billing_ListCustomField responses: '200': description: A successful response.(streaming responses) schema: type: object properties: result: $ref: '#/definitions/v1CustomField' error: $ref: '#/definitions/rpcStatus' title: Stream result of v1CustomField default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: body in: body required: true schema: $ref: '#/definitions/v1ListCustomFieldRequest' tags: - Billing /v1/customizedbillingservices: post: summary: Creates the customized billing service. Only available in Ripple. operationId: Billing_CreateCustomizedBillingService responses: '200': description: A successful response. schema: $ref: '#/definitions/rippleCustomizedBillingService' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: body description: Request message for the Billing.CreateCustomizedBillingService rpc. in: body required: true schema: $ref: '#/definitions/v1CreateCustomizedBillingServiceRequest' tags: - Billing /v1/customizedbillingservices/billinggroup/{groupId}/{vendor}: get: summary: Gets the customized billing service in billing group. Only available in Ripple. operationId: Billing_GetCustomizedBillingServiceBillingGroup responses: '200': description: A successful response.(streaming responses) schema: type: object properties: result: $ref: '#/definitions/v1GetCustomizedBillingServiceBillingGroupResponse' error: $ref: '#/definitions/rpcStatus' title: Stream result of v1GetCustomizedBillingServiceBillingGroupResponse default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: groupId description: Required. billing internal id in billing group. in: path required: true type: string - name: vendor description: Required. At the moment, `aws`,`azure`,`gcp` is supported. in: path required: true type: string tags: - Billing delete: summary: Deletes the customized billing service in billing group. Only available in Ripple. operationId: Billing_DeleteCustomizedBillingServiceBillingGroup responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: groupId description: Required. billing internal id in billing group. in: path required: true type: string - name: vendor description: Required. At the moment, `aws`,`azure`,`gcp` is supported. in: path required: true type: string tags: - Billing post: summary: Sets the customized billing service in billing group. Only available in Ripple. operationId: Billing_SetCustomizedBillingServiceBillingGroup responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: groupId description: Required. billing internal id in billing group. in: path required: true type: string - name: vendor description: Required. At the moment, `aws`,`azure`,`gcp` is supported. in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingSetCustomizedBillingServiceBillingGroupBody' tags: - Billing /v1/customizedbillingservices/{id}: get: summary: Gets the customized billing service. Only available in Ripple. operationId: Billing_GetCustomizedBillingService responses: '200': description: A successful response. schema: $ref: '#/definitions/rippleCustomizedBillingService' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: id description: Required. [blueapi.api.ripple.CustomizedBillingService.id] in: path required: true type: string - name: fieldMask description: 'Optional. Get only the value that set fieldMask. see more info: https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/field_mask.proto' in: query required: false type: string tags: - Billing delete: summary: Deletes the customized billing service. Only available in Ripple. operationId: Billing_DeleteCustomizedBillingService responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: id description: Required. [blueapi.api.ripple.CustomizedBillingService.id] in: path required: true type: string tags: - Billing put: summary: Updates the customized billing service by updating the fields specified in the update mask. Only available in Ripple. operationId: Billing_UpdateCustomizedBillingService responses: '200': description: A successful response. schema: $ref: '#/definitions/rippleCustomizedBillingService' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: id description: Required. [blueapi.api.ripple.CustomizedBillingService.id] in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingUpdateCustomizedBillingServiceBody' tags: - Billing /v1/customizedbillingservices:read: post: summary: Reads the customized billing service. Only available in Ripple. operationId: Billing_ReadCustomizedBillingServices responses: '200': description: A successful response.(streaming responses) schema: type: object properties: result: $ref: '#/definitions/rippleCustomizedBillingService' error: $ref: '#/definitions/rpcStatus' title: Stream result of rippleCustomizedBillingService default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: body description: Request message for the Billing.ReadCustomizedBillingServices rpc. in: body required: true schema: $ref: '#/definitions/v1ReadCustomizedBillingServicesRequest' tags: - Billing /v1/exchangerate/billinggroup/{month}: post: summary: Set billing group exchangerate. Only available in Ripple. operationId: Billing_SetBillingGroupExchangeRate responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: month description: 'Required. month. Format: `yyyymm`.' in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingSetBillingGroupExchangeRateBody' tags: - Billing /v1/exchangerate/global/{vendor}/{month}: post: summary: Set global exchangerate. Only available in Ripple. operationId: Billing_SetGlobalExchangeRate responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: vendor description: Required. vendor. in: path required: true type: string - name: month description: 'Required. month. Format: `yyyymm`.' in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingSetGlobalExchangeRateBody' tags: - Billing /v1/exchangerate/payer/{month}: post: summary: Set payer exchangerate. Only available in Ripple. operationId: Billing_SetPayerExchangeRate responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: month description: 'Required. month. Format: `yyyymm`.' in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingSetPayerExchangeRateBody' tags: - Billing /v1/exportcsv/billing-group: get: summary: Export the billing groups into csv format operationId: Billing_ExportBillingGroupCsv responses: '200': description: A successful response. schema: $ref: '#/definitions/v1ExportBillingGroupCsvResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: language description: "Usually the language of the user information is used, \nbut it may be a different language due to cahce.\nIn that case, you can use this option to change the language of CSV." in: query required: false type: string tags: - Billing /v1/exportcsv/invoice-setting: get: summary: Exports the invoice settings into csv format operationId: Billing_ExportInvoiceSettingCsv responses: '200': description: A successful response. schema: $ref: '#/definitions/v1ExportInvoiceSettingCsvResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: language description: "Usually the language of the user information is used, \nbut it may be a different language due to cahce.\nIn that case, you can use this option to change the language of CSV." in: query required: false type: string - name: includeMiscellaneous description: Optional. If true, include miscellaneous items in the settings export. in: query required: false type: boolean tags: - Billing /v1/freeformat: post: summary: Creates new billing group free format item (miscellaneous) operationId: Billing_CreateFreeFormat responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: body in: body required: true schema: $ref: '#/definitions/v1CreateFreeFormatRequest' tags: - Billing /v1/freeformat/{groupId}: get: summary: Get billing group free format item (miscellaneous) operationId: Billing_GetFreeFormat responses: '200': description: A successful response.(streaming responses) schema: type: object properties: result: $ref: '#/definitions/v1GetFreeFormatResponse' error: $ref: '#/definitions/rpcStatus' title: Stream result of v1GetFreeFormatResponse default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: groupId description: set empty to get all the freeformat of the MSP in: path required: true type: string - name: isAssociated description: 'this setting is ignored if groupId is not empty set true to return only the free format associated to a BG' in: query required: false type: boolean tags: - Billing delete: summary: Delete billing group free format item (miscellaneous) operationId: Billing_DeleteFreeFormat responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: groupId in: path required: true type: string - name: vendor in: query required: false type: string tags: - Billing /v1/invoice/displaysettings: get: summary: 'WORK-IN-PROGRESS: Gets the invoice display settings for invoice-ui' operationId: Billing_GetInvoiceDisplaySettings responses: '200': description: A successful response. schema: $ref: '#/definitions/v1GetInvoiceDisplaySettingsResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' tags: - Billing post: summary: Creates/Updates an invoice display settings. Only available in Ripple. operationId: Billing_UpdateInvoiceDisplaySettings responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: body description: Request message for UpdateInvoiceDisplaySettings rpc. in: body required: true schema: $ref: '#/definitions/v1UpdateInvoiceDisplaySettingsRequest' tags: - Billing /v1/invoice/exchangerate/{month}: put: summary: Update invoice exchangerate for the month operationId: Billing_UpdateInvoiceExchangeRate responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: month description: 'Required. Format: yyyymm.' in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingUpdateInvoiceExchangeRateBody' tags: - Billing /v1/invoice/status/{date}:read: post: summary: Reads an invoice status. Only available in Ripple. operationId: Billing_ListInvoiceStatus responses: '200': description: A successful response.(streaming responses) schema: type: object properties: result: $ref: '#/definitions/apiInvoiceMessage' error: $ref: '#/definitions/rpcStatus' title: Stream result of apiInvoiceMessage default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: date description: 'Required. Month to get invoice status. Format: `yyyymm`.' in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingListInvoiceStatusBody' tags: - Billing /v1/invoice/status/{id}: get: summary: Gets an invoice. Only available in Ripple. operationId: Billing_GetInvoiceStatus responses: '200': description: A successful response. schema: $ref: '#/definitions/apiInvoiceMessage' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: id description: Required. invoice generate request id. in: path required: true type: string tags: - Billing /v1/invoice/template: get: summary: Lists Invoice Template. Only available in Ripple. operationId: Billing_ListInvoiceTemplate responses: '200': description: A successful response.(streaming responses) schema: type: object properties: result: $ref: '#/definitions/v1ListInvoiceTemplateResponse' error: $ref: '#/definitions/rpcStatus' title: Stream result of v1ListInvoiceTemplateResponse default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' tags: - Billing /v1/invoice/{date}:converttopdf: post: summary: 'WORK-IN-PROGRESS: Convert invoice to pdf' operationId: Billing_ConvertInvoiceToPdf responses: '200': description: A successful response. schema: $ref: '#/definitions/v1ConvertInvoiceToPdfResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: date description: 'Required. Format: yyyymm.' in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingConvertInvoiceToPdfBody' tags: - Billing /v1/invoice/{date}:create: post: summary: Creates an invoice. Only available in Ripple. operationId: Billing_CreateInvoice responses: '200': description: A successful response. schema: $ref: '#/definitions/apiInvoiceMessage' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: date description: 'Required. Month to get invoice. Format: `yyyymm`.' in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingCreateInvoiceBody' tags: - Billing /v1/invoice/{date}:create&savesettings: post: summary: Creates an invoice and add settings. Only available in Ripple. operationId: Billing_CreateInvoiceWithSettings responses: '200': description: A successful response. schema: $ref: '#/definitions/apiInvoiceMessage' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: date description: 'Required. Invoice month. Format: `yyyymm`.' in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingCreateInvoiceWithSettingsBody' tags: - Billing /v1/invoice/{date}:export: post: summary: Exports an invoice. operationId: Billing_ExportInvoiceFile responses: '200': description: A successful response. schema: $ref: '#/definitions/v1ExportInvoiceFileResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: date description: 'Required. Month to get invoice. Format: `yyyymm`.' in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingExportInvoiceFileBody' tags: - Billing /v1/invoice/{date}:preview: put: summary: Updates an invoice preview. Only available in Ripple. operationId: Billing_UpdateInvoicePreviews responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: date description: 'Required. Month to get invoice. Format: `yyyymm`.' in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingUpdateInvoicePreviewsBody' tags: - Billing /v1/invoice/{date}:read: post: summary: Gets an invoice. operationId: Billing_GetInvoice responses: '200': description: A successful response. schema: $ref: '#/definitions/apiInvoice' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: date description: 'Required. Month to get invoice. Format: `yyyymm`.' in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingGetInvoiceBody' tags: - Billing /v1/invoice/{date}:savesettings: post: summary: 'WORK-IN-PROGRESS: Save invoice settings for the month' operationId: Billing_SaveInvoiceSettings responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: date description: 'Required. Invoice month. Format: `yyyymm`.' in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingSaveInvoiceSettingsBody' tags: - Billing /v1/invoice:read: post: summary: Reads list of the invoice. operationId: Billing_ListInvoice responses: '200': description: A successful response.(streaming responses) schema: type: object properties: result: $ref: '#/definitions/v1ListInvoiceResponse' error: $ref: '#/definitions/rpcStatus' title: Stream result of v1ListInvoiceResponse default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: body description: Request message for the ListInvoice rpc. in: body required: true schema: $ref: '#/definitions/v1ListInvoiceRequest' tags: - Billing /v1/invoicelayoutconfig: post: summary: WORK-IN-PROGRESS. Creates an invoice layout config. operationId: Billing_CreateInvoiceLayoutConfig responses: '200': description: A successful response. schema: $ref: '#/definitions/v1CreateInvoiceLayoutConfigResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: body in: body required: true schema: $ref: '#/definitions/v1CreateInvoiceLayoutConfigRequest' tags: - Billing /v1/invoicelayoutconfig/{id}: delete: summary: WORK-IN-PROGRESS. Delete an invoice layout config. operationId: Billing_DeleteInvoiceLayoutConfig responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: id description: Required. The invoice layout config id. in: path required: true type: string tags: - Billing put: summary: WORK-IN-PROGRESS. Updates an invoice layout config. operationId: Billing_UpdateInvoiceLayoutConfig responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: id description: Required. The layout id to be updated in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingUpdateInvoiceLayoutConfigBody' tags: - Billing /v1/invoicelayoutconfig:read: post: summary: WORK-IN-PROGRESS. Reads all invoice layout config under an msp. operationId: Billing_ReadInvoiceLayoutConfig responses: '200': description: A successful response.(streaming responses) schema: type: object properties: result: $ref: '#/definitions/v1ReadInvoiceLayoutConfigResponse' error: $ref: '#/definitions/rpcStatus' title: Stream result of v1ReadInvoiceLayoutConfigResponse default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: body in: body required: true schema: $ref: '#/definitions/v1ReadInvoiceLayoutConfigRequest' tags: - Billing /v1/reseller/announcement: post: summary: Creates new announcement for wave users operationId: Billing_CreateAnnouncement responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: body in: body required: true schema: $ref: '#/definitions/v1CreateAnnouncementRequest' tags: - Billing /v1/reseller/announcement/{announcementId}: delete: operationId: Billing_DeleteAnnouncement responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: announcementId description: Required in: path required: true type: string tags: - Billing put: summary: Full update existing announcement operationId: Billing_UpdateAnnouncement responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: announcementId description: Required in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingUpdateAnnouncementBody' tags: - Billing /v1/reseller/announcements/bulk/status: patch: summary: Update multiple announcements status operationId: Billing_UpdateAnnouncementsStatus responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: body in: body required: true schema: $ref: '#/definitions/v1UpdateAnnouncementsStatusRequest' tags: - Billing /v1/reseller/announcements/{announcementId}/date: patch: summary: Update announcement date operationId: Billing_UpdateAnnouncementDate responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: announcementId in: path required: true type: array items: type: string collectionFormat: csv minItems: 1 - name: body in: body required: true schema: $ref: '#/definitions/BillingUpdateAnnouncementDateBody' tags: - Billing /v1/resellers: get: summary: ListResellers description: '**Lists all the reseller accounts.** > **Only available in Ripple.**' operationId: Billing_ListResellers responses: '200': description: A successful response.(streaming responses) schema: type: object properties: result: $ref: '#/definitions/rippleReseller' error: $ref: '#/definitions/rpcStatus' title: Stream result of rippleReseller default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: fieldMask description: 'Optional. Get only the value that set fieldMask. see more info: https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/field_mask.proto' in: query required: false type: string tags: - Billing post: summary: Registers the reseller account. Only available in Ripple. operationId: Billing_CreateReseller responses: '200': description: A successful response. schema: $ref: '#/definitions/rippleReseller' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: body description: Request message for the CreateReseller rpc. in: body required: true schema: $ref: '#/definitions/v1CreateResellerRequest' tags: - Billing /v1/resellers/{id}: get: summary: Gets the reseller account. Only available in Ripple. operationId: Billing_GetReseller responses: '200': description: A successful response. schema: $ref: '#/definitions/rippleReseller' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: id description: Required. reseller id. in: path required: true type: string - name: fieldMask description: 'Optional. Get only the value that set fieldMask. see more info: https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/field_mask.proto' in: query required: false type: string tags: - Billing delete: summary: Deletes the reseller account. Only available in Ripple. operationId: Billing_DeleteReseller responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: id description: Required. reseller id. in: path required: true type: string tags: - Billing put: summary: Updates the reseller account. Only available in Ripple. operationId: Billing_UpdateReseller responses: '200': description: A successful response. schema: $ref: '#/definitions/rippleReseller' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: id description: Required. reseller id. in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingUpdateResellerBody' tags: - Billing /v1/resources/accounts/{vendor}: get: summary: 'WORK-IN-PROGRESS: Returns all registered accounts that are not associated to any billing groups and accounts found in CUR for the specified month. For Ripple only' operationId: Billing_ListAccountResources responses: '200': description: A successful response.(streaming responses) schema: type: object properties: result: $ref: '#/definitions/v1ResourceAccount' error: $ref: '#/definitions/rpcStatus' title: Stream result of v1ResourceAccount default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: vendor description: Required. At the moment, only `aws`,`azure`,`gcp` is supported. in: path required: true type: string - name: month description: Optional. The UTC month to query. If empty, defaults to current month. Format is `yyyymm`. in: query required: false type: string tags: - Billing /v1/servicediscounts: post: summary: Creates the invoice service discounts. Only available in Ripple. operationId: Billing_CreateInvoiceServiceDiscounts responses: '200': description: A successful response. schema: $ref: '#/definitions/apiRippleV1InvoiceServiceDiscounts' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: body description: Request message for the Billing.CreateInvoiceServiceDiscounts rpc. in: body required: true schema: $ref: '#/definitions/v1CreateInvoiceServiceDiscountsRequest' tags: - Billing /v1/servicediscounts/account:export: post: summary: Exports service discounts for account in billing group. Only available in Ripple. operationId: Billing_ExportAccountInvoiceServiceDiscounts responses: '200': description: A successful response. schema: $ref: '#/definitions/v1AccountServiceDiscountsExport' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: body description: Request message for the ExportAccountInvoiceServiceDiscounts rpc. in: body required: true schema: $ref: '#/definitions/v1ExportAccountInvoiceServiceDiscountsRequest' tags: - Billing /v1/servicediscounts/billinggroup:export: post: summary: Exports service discounts for billing group. Only available in Ripple. operationId: Billing_ExportBillingGroupInvoiceServiceDiscounts responses: '200': description: A successful response. schema: $ref: '#/definitions/v1GroupServiceDiscountsExport' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: body description: Request message for the ExportBillingGroupInvoiceServiceDiscounts rpc. in: body required: true schema: $ref: '#/definitions/v1ExportBillingGroupInvoiceServiceDiscountsRequest' tags: - Billing /v1/servicediscounts/{groupId}/account: delete: summary: Deletes the account invoice service discounts. Only available in Ripple. operationId: Billing_DeleteAccountInvoiceServiceDiscounts responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: groupId description: 'Required. For Ripple, only billing internal ids are supported at the moment. You can set it to a single group Implied as the parent billing group for Wave(Pro) users.' in: path required: true type: string tags: - Billing post: summary: Registers the account invoice service discounts. Only available in Ripple. operationId: Billing_CreateAccountInvoiceServiceDiscounts responses: '200': description: A successful response. schema: $ref: '#/definitions/v1CreateAccountInvoiceServiceDiscountsResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: groupId description: 'Required. For Ripple, only billing internal ids are supported at the moment. You can set it to a single group Implied as the parent billing group for Wave(Pro) users.' in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingCreateAccountInvoiceServiceDiscountsBody' tags: - Billing put: summary: Updates the account invoice service discounts. Only available in Ripple. operationId: Billing_UpdateAccountInvoiceServiceDiscounts responses: '200': description: A successful response. schema: $ref: '#/definitions/v1UpdateAccountInvoiceServiceDiscountsResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: groupId description: 'Required. For Ripple, only billing internal ids are supported at the moment. You can set it to a single group Implied as the parent billing group for Wave(Pro) users.' in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingUpdateAccountInvoiceServiceDiscountsBody' tags: - Billing /v1/servicediscounts/{groupId}/account:read: post: summary: Reads the account invoice service discounts. Only available in Ripple. operationId: Billing_ListAccountInvoiceServiceDiscounts responses: '200': description: A successful response.(streaming responses) schema: type: object properties: result: $ref: '#/definitions/v1AccountInvoiceServiceDiscounts' error: $ref: '#/definitions/rpcStatus' title: Stream result of v1AccountInvoiceServiceDiscounts default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: groupId description: 'Required. For Ripple, only billing internal ids are supported at the moment. You can set it to a single group Implied as the parent billing group for Wave(Pro) users.' in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingListAccountInvoiceServiceDiscountsBody' tags: - Billing /v1/servicediscounts/{groupId}/account:remove: put: summary: Removes the account invoice service discounts. Only available in Ripple. operationId: Billing_RemoveAccountInvoiceServiceDiscounts responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: groupId description: 'Required. For Ripple, only billing internal ids are supported at the moment. You can set it to a single group Implied as the parent billing group for Wave(Pro) users.' in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingRemoveAccountInvoiceServiceDiscountsBody' tags: - Billing /v1/servicediscounts/{groupId}/billinggroup: get: summary: Returns the service discount associated with the billing group id operationId: Billing_GetBillingGroupInvoiceServiceDiscounts responses: '200': description: A successful response. schema: $ref: '#/definitions/v1GetBillingGroupInvoiceServiceDiscountsResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: groupId in: path required: true type: string tags: - Billing delete: summary: Deletes the billing group invoice service discounts. Only available in Ripple. operationId: Billing_DeleteBillingGroupInvoiceServiceDiscounts responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: groupId description: 'Required. For Ripple, only billing internal ids are supported at the moment. You can set it to a single group Implied as the parent billing group for Wave(Pro) users.' in: path required: true type: string tags: - Billing post: summary: Registers the billing group invoice service discounts. Only available in Ripple. operationId: Billing_CreateBillingGroupInvoiceServiceDiscounts responses: '200': description: A successful response. schema: $ref: '#/definitions/v1CreateBillingGroupInvoiceServiceDiscountsResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: groupId description: 'Required. For Ripple, only billing internal ids are supported at the moment. You can set it to a single group Implied as the parent billing group for Wave(Pro) users.' in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingCreateBillingGroupInvoiceServiceDiscountsBody' tags: - Billing put: summary: Updates the billing group invoice service discounts. Only available in Ripple. operationId: Billing_UpdateBillingGroupInvoiceServiceDiscounts responses: '200': description: A successful response. schema: $ref: '#/definitions/v1UpdateBillingGroupInvoiceServiceDiscountsResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: groupId description: 'Required. For Ripple, only billing internal ids are supported at the moment. You can set it to a single group Implied as the parent billing group for Wave(Pro) users.' in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingUpdateBillingGroupInvoiceServiceDiscountsBody' tags: - Billing /v1/servicediscounts/{id}: get: summary: Gets the invoice service discounts. Only available in Ripple. operationId: Billing_GetInvoiceServiceDiscounts responses: '200': description: A successful response. schema: $ref: '#/definitions/apiRippleV1InvoiceServiceDiscounts' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: id description: Required. [blueapi.api.ripple.v1.InvoiceServiceDiscounts.id]. in: path required: true type: string - name: fieldMask description: 'Optional. Get only the value that set fieldMask. see more info: https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/field_mask.proto' in: query required: false type: string tags: - Billing delete: summary: Deletes the invoice service discounts. Only available in Ripple. operationId: Billing_DeleteInvoiceServiceDiscounts responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: id description: Required. [blueapi.api.ripple.v1.InvoiceServiceDiscounts.id] in: path required: true type: string tags: - Billing put: summary: Updates the invoice service discounts. Only available in Ripple. operationId: Billing_UpdateInvoiceServiceDiscounts responses: '200': description: A successful response. schema: $ref: '#/definitions/apiRippleV1InvoiceServiceDiscounts' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: id description: Required. [blueapi.api.ripple.v1.InvoiceServiceDiscounts.id] in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingUpdateInvoiceServiceDiscountsBody' tags: - Billing /v1/servicediscounts/{vendor}/services:read: post: summary: Reads the service relate to the service discounts. Only available in Ripple. operationId: Billing_ReadServiceDiscountsServices responses: '200': description: A successful response.(streaming responses) schema: type: object properties: result: $ref: '#/definitions/v1Service' error: $ref: '#/definitions/rpcStatus' title: Stream result of v1Service default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: vendor description: Required. At the moment, only `aws`,`azure`,`gcp` is supported. in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingReadServiceDiscountsServicesBody' tags: - Billing /v1/servicediscounts:export: post: summary: Exports service discounts. Only available in Ripple. operationId: Billing_ExportServiceDiscounts responses: '200': description: A successful response. schema: $ref: '#/definitions/v1ServiceDiscountsExport' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: body description: Request message for the ExportServiceDiscounts rpc. in: body required: true schema: $ref: '#/definitions/v1ExportServiceDiscountsRequest' tags: - Billing /v1/servicediscounts:read: post: summary: Reads the invoice service discounts. Only available in Ripple. operationId: Billing_ListInvoiceServiceDiscounts responses: '200': description: A successful response.(streaming responses) schema: type: object properties: result: $ref: '#/definitions/blueapiBillingV1InvoiceServiceDiscounts' error: $ref: '#/definitions/rpcStatus' title: Stream result of blueapiBillingV1InvoiceServiceDiscounts default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: body description: Request message for the ListInvoiceServiceDiscounts rpc. in: body required: true schema: $ref: '#/definitions/v1ListInvoiceServiceDiscountsRequest' tags: - Billing /v1/settings: get: summary: 'WORK-IN-PROGRESS: Gets all billing settings.' operationId: Billing_GetBillingSetting responses: '200': description: A successful response. schema: $ref: '#/definitions/v1GetBillingSettingResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: fieldMask description: 'Optional. Get only the value that set fieldMask. see more info: https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/field_mask.proto' in: query required: false type: string tags: - Billing /v1/tags: get: summary: "Returns the customer details and its tags. \nPort for: m/ripple/tags/vendor/{vendor}?type={type}" operationId: Billing_GetTags responses: '200': description: A successful response.(streaming responses) schema: type: object properties: result: $ref: '#/definitions/billingV1TagData' error: $ref: '#/definitions/rpcStatus' title: Stream result of billingV1TagData default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: vendor in: query required: false type: string - name: type in: query required: false type: string tags: - Billing /v1/{vendor}/adjustmententries/customfees: post: summary: 'Creates custom fee entries in the RIPPLE_FEES table. Used to write Guaranteed Commitment entries and Custom Fee entries directly to the fee table. Only available in Ripple.' operationId: Billing_CreateCustomFee responses: '200': description: A successful response. schema: $ref: '#/definitions/v1CreateCustomFeeResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: vendor description: Required. At the moment, only `aws` is supported. in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingCreateCustomFeeBody' tags: - Billing /v1/{vendor}/adjustmententries/{id}: get: summary: Gets the adjustment entry. Only available in Ripple. operationId: Billing_GetAdjustmentEntry responses: '200': description: A successful response. schema: $ref: '#/definitions/v1AdjustmentEntry' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: vendor description: Required. At the moment, only `aws`,`azure`,`gcp` is supported. in: path required: true type: string - name: id description: Required. The adjustment entry id. [blueapi.api.ripple.v1.AdjustmentEntry.id] in: path required: true type: string tags: - Billing /v1/{vendor}/adjustmententries/{id}/allocate: post: summary: Allocates the adjustment entry item. Only available in Ripple. operationId: Billing_AllocateAdjustmentEntry responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: vendor description: Required. At the moment, only `aws` is supported. in: path required: true type: string - name: id description: Required. AdjustmentEntry ID. in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingAllocateAdjustmentEntryBody' tags: - Billing /v1/{vendor}/adjustmententries/{id}/allocate:restore: post: summary: Restores the allocate adjustment entry item. Only available in Ripple. operationId: Billing_RestoreAllocateAdjustmentEntry responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: vendor description: Required. At the moment, only `aws` is supported. in: path required: true type: string - name: id description: Required. AdjustmentEntry ID. in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingRestoreAllocateAdjustmentEntryBody' tags: - Billing /v1/{vendor}/adjustmententries/{id}/split: post: summary: Splits the adjustment entry item. Only available in Ripple. operationId: Billing_SplitAdjustmentEntry responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: vendor description: Required. At the moment, only `aws` is supported. in: path required: true type: string - name: id description: Required. AdjustmentEntry ID. in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingSplitAdjustmentEntryBody' tags: - Billing /v1/{vendor}/adjustmententries/{id}/split:restore: post: summary: Restores the splitted adjustment entry item. Only available in Ripple. operationId: Billing_RestoreSplitAdjustmentEntry responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: vendor description: Required. At the moment, only `aws` is supported. in: path required: true type: string - name: id description: Required. AdjustmentEntry ID. in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingRestoreSplitAdjustmentEntryBody' tags: - Billing /v1/{vendor}/adjustmententries:apply: post: summary: Applies the adjustment entry item. Only available in Ripple. operationId: Billing_ApplyAdjustmentEntry responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: vendor description: Required. At the moment, only `aws`,`azure`,`gcp` is supported. in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingApplyAdjustmentEntryBody' tags: - Billing /v1/{vendor}/adjustmententries:read: post: summary: Reads the adjustment entries. Only available in Ripple. operationId: Billing_ReadAdjustmentEntries responses: '200': description: A successful response.(streaming responses) schema: type: object properties: result: $ref: '#/definitions/v1AdjustmentEntry' error: $ref: '#/definitions/rpcStatus' title: Stream result of v1AdjustmentEntry default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: vendor description: Required. At the moment, only `aws`,`azure`,`gcp` is supported. in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingReadAdjustmentEntriesBody' tags: - Billing /v1/{vendor}/adjustmententries:restore: post: summary: Restores the adjustment entry item. Only available in Ripple. operationId: Billing_RestoreAdjustmentEntry responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: vendor description: Required. At the moment, only `aws`,`azure`,`gcp` is supported. in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingRestoreAdjustmentEntryBody' tags: - Billing /v1/{vendor}/adjustmententryitems:read: post: summary: 'Lists adjustment entry items from the fee table. Reads fee entries from the RIPPLE_FEES table, optionally filtered by mobingi_type. Note: Commitment entries (mobingi_type="COMMITMENT") are excluded from ReadAdjustmentEntries to avoid duplication with the Adjusting Entries UI. Only available in Ripple.' operationId: Billing_ListAdjustmentEntryItems responses: '200': description: A successful response.(streaming responses) schema: type: object properties: result: $ref: '#/definitions/v1AdjustmentEntryItem' error: $ref: '#/definitions/rpcStatus' title: Stream result of v1AdjustmentEntryItem default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: vendor description: Required. At the moment, only `aws` is supported. in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingListAdjustmentEntryItemsBody' tags: - Billing /v1/{vendor}/billinggroups/children/{internalId}/customizedBillingService: get: summary: Gets the customized billing service in child billing group. Only available in Ripple. operationId: Billing_GetChildBillingGroupCustomizedBillingService responses: '200': description: A successful response.(streaming responses) schema: type: object properties: result: $ref: '#/definitions/v1GetChildBillingGroupCustomizedBillingServiceResponse' error: $ref: '#/definitions/rpcStatus' title: Stream result of v1GetChildBillingGroupCustomizedBillingServiceResponse default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: vendor description: Required. At the moment, `aws` is supported. in: path required: true type: string - name: internalId description: Required. Internal Id in: path required: true type: string tags: - Billing post: summary: Sets the customized billing service in child billing group. Only available in Ripple. operationId: Billing_SetChildBillingGroupCustomizedBillingService responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: vendor description: Required. At the moment, `aws` is supported. in: path required: true type: string - name: internalId description: Required. internal id of the child billing group. in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingSetChildBillingGroupCustomizedBillingServiceBody' tags: - Billing /v1/{vendor}/exchangerate/{month}: get: summary: ListExchangeRates description: 'Lists all exchange rate. > Only available in Ripple.' operationId: Billing_ListExchangeRates responses: '200': description: A successful response. schema: $ref: '#/definitions/blueapiBillingV1ListExchangeRatesResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: vendor description: Required. vendor. in: path required: true type: string - name: month description: 'Required. month. Format: `yyyymm`.' in: path required: true type: string tags: - Billing /v1/{vendor}/invoiceadjustments:read: post: summary: Reads the adjustment details involved in invoicing of an organization billing group (Wave). operationId: Billing_ReadInvoiceAdjustments responses: '200': description: A successful response.(streaming responses) schema: type: object properties: result: $ref: '#/definitions/waveAdjustment' error: $ref: '#/definitions/rpcStatus' title: Stream result of waveAdjustment default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: vendor description: Required. At the moment, only `aws`,`azure`,`gcp` is supported. in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingReadInvoiceAdjustmentsBody' tags: - Billing /v1/{vendor}/services: get: summary: 'Lists available cloud services and their associated SKUs for a given vendor. Use this to retrieve service codes and names that can be referenced in exclude service settings.' operationId: Billing_ListServices responses: '200': description: A successful response. schema: $ref: '#/definitions/v1ListServicesResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: vendor description: Required. Cloud vendor (e.g., "gcp"). Bound from the URL path. in: path required: true type: string - name: code description: 'Optional. Service code to filter by. Example values: "6F81-5844-456A" (Cloud Storage), "95FF-2EF5-5EA1" (Compute Engine), "152E-C115-5142" (Cloud SQL). Use ListServices without this field to retrieve all available service codes.' in: query required: false type: string tags: - Billing /v1/{vendor}/tagsaddingsetting/{groupId}: get: operationId: Billing_GetTagsAddingSetting responses: '200': description: A successful response.(streaming responses) schema: type: object properties: result: $ref: '#/definitions/v1TagsAddingSetting' error: $ref: '#/definitions/rpcStatus' title: Stream result of v1TagsAddingSetting default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: vendor in: path required: true type: string - name: groupId in: path required: true type: string tags: - Billing put: operationId: Billing_UpdateTagsAddingSetting responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: vendor in: path required: true type: string - name: groupId in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingUpdateTagsAddingSettingBody' tags: - Billing /v1/{vendor}/untaggedgroups:read: post: summary: Reads the untagged group. Only available in Ripple. operationId: Billing_ReadUntaggedGroups responses: '200': description: A successful response.(streaming responses) schema: type: object properties: result: $ref: '#/definitions/rippleUntaggedGroup' error: $ref: '#/definitions/rpcStatus' title: Stream result of rippleUntaggedGroup default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: vendor description: Required. At the moment, only `aws` is supported. in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingReadUntaggedGroupsBody' tags: - Billing /v1/{vendor}/usagecostsdrift:read: post: summary: Returns a list of accounts that have been updated after invoice along with the differences in costs, if any. Only available in Ripple. operationId: Billing_ListUsageCostsDrift responses: '200': description: A successful response.(streaming responses) schema: type: object properties: result: $ref: '#/definitions/v1UsageCostsDrift' error: $ref: '#/definitions/rpcStatus' title: Stream result of v1UsageCostsDrift default: description: An unexpected error response. schema: $ref: '#/definitions/rpcStatus' parameters: - name: vendor description: Required. At the moment, only `aws` is supported. in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BillingListUsageCostsDriftBody' tags: - Billing definitions: billingV1InvoiceSettings: type: object properties: invoiceNo: type: string discountRate: type: number format: double discountTargetUsage: type: string description: e.g., cloudpaywithfee, ... discountCalcLogic: type: string description: e.g., usageamount, ... taxRate: type: number format: double supportFee: type: string title: e.g., percent, fix, aws_developer, aws_business, aws_enterprise supportRate: type: number format: double supportFeeCalcTarget: type: string description: e.g., nondiscount, ... supportFix: type: number format: double substitutionFee: type: string title: e.g., percent, fix, automatic, usagetable substitutionRate: type: number format: double substitutionFix: type: number format: double substitutionFeeCalcTarget: type: string description: e.g., nondiscount, ... substitutionFeeTargetUsage: type: string title: e.g., cloudpayonly, cloudpaywithfee substitutionFeeCalcType: type: string title: e.g., allsum, account currency: type: string title: Currency used for the invoice (e.g., "jpy", "inr") exchangeRate: type: number format: double title: 'Exchange rate from USD to the invoice currency Example: If the invoice currency is "jpy" and 1 USD = 150 jpy, exchangeRate = 150' memo: type: string calcType: type: string title: e.g., account, tag additionalItems: type: array items: type: object $ref: '#/definitions/v1FreeFormItem' supportFeeAdjustment: type: number format: double rippleTieredPrice: type: object properties: tiredConfig: type: array items: type: object $ref: '#/definitions/rippleTierdConfig' service: $ref: '#/definitions/rippleTargetServiceConfig' usage: $ref: '#/definitions/rippleTargetUsageConfig' discounted: type: boolean title: tired price ripplePercentage: type: object properties: value: type: number format: double service: $ref: '#/definitions/rippleTargetServiceConfig' usage: $ref: '#/definitions/rippleTargetUsageConfig' discounted: type: boolean title: percentage BillingUpdateAnnouncementDateBody: type: object properties: date: type: string format: int64 title: Required. Announcement date (epoch time) v1ExcludeServiceEntry: type: object properties: mspId: type: string description: MSP (Managed Service Provider) ID. vendor: type: string description: Cloud vendor (e.g., "aws", "gcp"). payerId: type: string description: Payer/account ID. service: type: string description: Cloud service name. product: type: string description: Product or SKU code. exceptPayerId: type: array items: type: string description: List of payer IDs excepted from exclusion. action: type: string description: Action performed (e.g., "added", "updated", "deleted"). status: type: string description: Operation status (e.g., "success", "error"). errorMessage: type: string description: Optional error message if operation failed. BillingReadInvoiceAdjustmentsBody: type: object properties: accountId: type: string description: Required. month: type: string description: Optional. The UTC month to query. If empty, defaults to current month. Format is `yyyymm`. For example, June 2021 will be `202106`. feeType: type: string description: Optional. If empty, defaults to all fee type. At the moment, only `Fee`,`Refund`,`Credit`,`SppDiscount`,`EdpDiscount`,`BundledDiscount` is supported. description: Request message for the Billing.ReadInvoiceAdjustments rpc. ripplebodyInvoiceLayout: type: object properties: hideSpecificTotalLines: type: array items: type: string title: 'The hideSpecificTotalLines is name of hide specific total lines. ex)BODY_HIDE_SPECIFIC_TOTAL_LINES: ["removeThisTextToApply _AWS_SUPPORT_BUSINESS"]' serviceDiscountDetail: type: boolean title: 'The serviceDiscountDetail is setting for service discount detail. ex)BODY_SERVICE_DISCOUNT_DETAIL: true' usageDiscount: type: boolean title: 'The usageDiscount is setting for usage discount. ex)BODY_USAGE_DISCOUNT: true' hideMarketplace: type: boolean title: 'The hideMarketplace is setting for hide marketplace. ex)BODY_HIDE_MARKETPLACE: true' description: 'WORK-IN-PROGRESS: bodyInvoiceLayout resource definition.' rippletotalInvoiceLayout: type: object properties: marketplace: type: string title: 'The totalMarketplace is name of marketplace total usage. ex)ALL_AWS_MARKETPLACE: ""' marketplaceFee: type: string title: 'The totalMarketplaceFee is name of marketplace total fee usage. ex)ALL_AWS_MARKETPLACE_FEES: ""' vendorTotal: type: string title: 'The vendorTotal is name of vendor total usage. ex)ALL_AWS_TOTAL: ""' vendorUsageOnly: type: string title: 'The vendorUsageOnly is name of vendor usage only. ex)ALL_AWS_USAGEONLY: ""' vendorlUsage: type: string title: 'The vendorTotalUsage is name of vendor total usage. ex)ALL_AWS_USAGE: "AWS利用料"' customUsage: type: string title: 'The customTotalUsage is name of custom total usage. ex)ALL_CUSTOM_USAGE: "追加費用合計"' discount: type: string title: 'The discount is name of discount. ex)ALL_DISCOUNT: ""' discountDiff: type: string title: 'The discountTotalDiff is name of discount total diff. ex)ALL_DISCOUNT_DIFF: "値引後"' subTotal: type: string title: 'The subTotal is name of sub total. ex)ALL_SUB_TOTAL: ""' substitutionFee: type: string title: 'The substitutionTotalFee is name of substitution total fee. ex)ALL_SUBSTITUTION: "請求代行手数料"' supportFee: type: string title: 'The supportTotalFee is name of support total fee. ex)ALL_SUPPORT_BUSINESS: "サポートビジネス費用"' tax: type: string title: 'The tax is name of tax. ex)ALL_TAX: "消費税"' taxDiff: type: string title: 'The taxDiff is name of tax diff. ex)ALL_TAX_DIFF: null' taxFree: type: string title: 'The taxFree is name of tax free. ex)ALL_TAX_FREE: ""' totalExchangeRate: type: string title: 'The totalExchangeRate is name of total exchange rate. ex)ALL_TOTAL_EXCHANGE: "日本円換算後($1=JPY)"' totalUsage: type: string title: 'The totalUsage is name of total usage. ex)ALL_USAGE_TOTAL: "小計"' total: type: string title: 'The total is name of total. ex)ALL_TOTAL: ""' description: 'WORK-IN-PROGRESS: totalInvoiceLayout resource definition.' v1ListInvoiceRequest: type: object properties: date: type: string title: YYYYMM format (e.g 202412, 202501) vendor: type: string title: 'OPTIONAL: vendor (aws, azure, gcp)' billingInternalId: type: string description: Optional. If set, return only child invoices for this billing group. fieldMask: type: string description: 'Optional. Get only the value that set fieldMask. see more info: https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/field_mask.proto' description: Request message for the ListInvoice rpc. v1AbcAccount: type: object properties: accountId: type: string accountName: type: string BillingRemoveAccountInvoiceServiceDiscountsBody: type: object properties: accounts: type: array items: type: object $ref: '#/definitions/v1AccountServiceDiscounts' description: Required. v1ExportBillingGroupInvoiceServiceDiscountsRequest: type: object properties: format: type: string description: Required. At the moment, `CSV` is supported. language: type: string description: "Optional. At the moment, `ja`,`en` is supported.\n\nUsually the language of the user information is used, \nbut it may be a different language due to cahce.\nIn that case, you can use this option to change the language of CSV." directLink: type: boolean title: Returns a directLink if set to true description: Request message for the ExportBillingGroupInvoiceServiceDiscounts rpc. required: - format apiRippleAccessGroup: type: object properties: id: type: string name: type: string description: type: string billingGroups: type: array items: type: string description: AccessGroup resource definition. AccountHistory: type: object properties: timestamp: type: string description: Calculation timestamp in UTC, RFC3339. trigger: type: string description: Calculation trigger. Either `invoice` or `cur`. v1CreateCustomFieldRequest: type: object properties: key: type: string description: type: string BillingUpdateBillingGroupInvoiceServiceDiscountsBody: type: object properties: id: type: string description: 'Required. Service discount id.' description: Request message for the UpdateBillingGroupInvoiceServiceDiscounts rpc. v1SupportPlan: type: string enum: - NO_SUPPORT - AWS_DEVELOPER - AWS_BUSINESS - AWS_ENTERPRISE - AWS_ENTERPRISE_ON_RAMP - AWS_BUSINESS_PLUS - AWS_ENTERPRISE_V2 - AWS_UNIFIED_OPERATIONS - GCP_STANDARD - GCP_ENHANCED - GCP_PREMIUM default: NO_SUPPORT description: "Describes the overall config of a [blueapi.api.ripple.v1.SupportPlan].\n\n - NO_SUPPORT: no_support\n - AWS_DEVELOPER: aws_developer\n - AWS_BUSINESS: aws_business\n - AWS_ENTERPRISE: aws_enterprise\n - AWS_ENTERPRISE_ON_RAMP: aws_enterprise_on_ramp\n - AWS_BUSINESS_PLUS: aws_business_plus\n - AWS_ENTERPRISE_V2: aws_enterprise_v2\n - AWS_UNIFIED_OPERATIONS: aws_unified_operations\n - GCP_STANDARD: gcp_standard\n - GCP_ENHANCED: gcp_enhanced\n - GCP_PREMIUM: gcp_premium" v1ServiceDiscountsExport: type: object properties: data: $ref: '#/definitions/v1ExportData' description: 'content. Base64 encoded value. For example, content :`` Decoding this value, get ``. downloadedRows. Downloaded content lines. totalRows.Total of content lines.' title: data is [blueapi.api.ripple.v1.ExportData] description: ServiceDiscountsExport resource definition. v1GetChildBillingGroupInvoiceServiceDiscountsResponse: type: object properties: id: type: string title: Service discount id rippleChargingTarget: type: string enum: - BILLINGGROUP - ACCOUNT default: BILLINGGROUP description: "Charging target\nIndicates that `ChargingTarget` in the setting applies to either BillingGroup or Account.\n\n - BILLINGGROUP: billing group\n - ACCOUNT: account" BillingSplitAdjustmentEntryBody: type: object properties: startMonth: type: string description: Required. The UTC month to query. If empty, defaults to current month. Format is `yyyymmdd`. For example, June 2021 will be `20210601`. description: Request message for the Billing.SplitAdjustmentEntry rpc. required: - startMonth apiGroupDetails: type: object properties: name: type: string currency: type: string amount: type: number format: double description: GroupDetails resource definition. v1AbcBillingGroup: type: object properties: arn: type: string name: type: string creationTime: type: string description: type: string primaryAccountId: type: string size: type: string status: type: string rippleBillingGroupInfo: type: object properties: billingTitle: type: string title: Optional. The title of the billing phoneNumber: type: string title: Optional. Company’s phone number postalCode: type: string title: Optional. Company’s postal code address: type: string title: Optional. Company’s address personal: type: string title: Optional. Addressee remarks: type: string title: Optional. Any remarks about the billing group projectId: type: string title: Optional. Project code language: type: string title: Optional. Invoice language displayCost: type: string title: Optional. Calculation type, true unblended or unblended exchangeRateType: type: string title: Optional. Exchange rate type, payer or billing group qrCode: type: boolean title: Optional. qrCode invoiceTemplateId: type: string title: Optional. Invoice template Id city: type: string title: Optional. Company's city prefecture: type: string title: Optional. Company's prefecture country: type: string title: Optional. Company's country state: type: string title: Optional. Company's state addressLine1: type: string title: Optional. Company's street address (primary line) addressLine2: type: string title: Optional. Company's street address (secondary line, e.g., apartment, suite, unit) description: BillingGroupInfo resource definition. Only available in Ripple. billingV1AwsOptions: type: object properties: useProFormaCur: type: boolean payerId: type: string description: Must not be empty if useProFormaCur is true. v1GetBillingGroupInvoiceServiceDiscountsResponse: type: object properties: id: type: string title: Service discount id v1BillingGroupListItem: type: object properties: billingGroupName: type: string description: Billing group display name. billingGroupId: type: string description: Billing group internal identifier. companyName: type: string description: Company name tied to the billing group. billingGroupType: type: string description: Billing group classification (e.g., ACCOUNT, TAG). vendors: type: array items: type: object $ref: '#/definitions/BillingGroupListItemBillingGroupVendor' description: Per-vendor availability list. billingInternalId: type: string description: Billing group's internal id reference. description: Response row for paginated billing groups table. BillingGroupListItemBillingGroupVendor: type: object properties: vendor: type: string description: Vendor identifier, e.g., aws, azure, gcp. enabled: type: boolean description: Indicates whether the billing group has this vendor active. description: Vendor availability entries. v1BillingGroupInvoiceSettings: type: object properties: aws: $ref: '#/definitions/v1BillingGroupVendoredInvoiceSetting' title: AWS invoice settings azure: $ref: '#/definitions/v1BillingGroupVendoredInvoiceSetting' title: Azure invoice settings gcp: $ref: '#/definitions/v1BillingGroupVendoredInvoiceSetting' title: GCP invoice settings description: Invoice settings for a billing group. v1Service: type: object properties: serviceCode: type: string description: The service code. serviceName: type: string description: The service name. description: 'Service resource definition. Services of each vendor available for Service Discounts.' rippleYearMonth: type: object properties: yearMonth: type: string description: List of the yearmonth. description: YearMonth resource definition. BillingUpdateBillingGroupFreeFormatBody: type: object properties: vendor: type: string items: type: array items: type: object $ref: '#/definitions/v1FreeFormItem' v1AwsDailyRunHistory: type: object properties: billingInternalId: type: string billingGroupId: type: string month: type: string accounts: type: array items: type: object $ref: '#/definitions/v1AwsDailyRunHistoryAccount' description: Streaming response message for the Billing.ListAwsDailyRunHistory rpc. apiManagementAccount: type: object properties: managementAccountId: type: string title: Vendor-managed organization account Id config: type: array items: type: object $ref: '#/definitions/apiConfigFilters' description: A list of filtering options. See [ConfigFilters] for more information on each filter item. Multiple filter items will use the logical 'or' operator, e.g. filter1 || filter2 || filter3, etc. description: ManagementAccount resource definition. BillingUpdateAdjustmentConfigBody: type: object properties: config: type: array items: type: object $ref: '#/definitions/apiConfigFilters' description: Optional. accounts: type: array items: type: object $ref: '#/definitions/apiManagementAccount' description: Optional. description: Request message for the Billing.UpdateAdjustmentConfig rpc. BillingUpdateTagsAddingSettingBody: type: object properties: items: type: array items: type: object $ref: '#/definitions/v1TagsAddingSetting' title: BillingGroup tags adding setting billingV1Tag: type: object properties: key: type: string title: Tag key value: type: string title: Tag value assign: type: integer format: int32 title: Assignment percentage (only used for non-tag assignments) title: Individual tag definition for AddTagsToBillingGroup v1CustomField: type: object properties: id: type: string description: Unique identifier for the custom field, automatically generated and immutable. key: type: string title: Descriptive name of the custom field description: type: string title: Detailed description of the custom field v1Tags: type: object properties: key: type: string values: type: array items: type: string blueapiApiFeeDetails: type: object properties: name: type: string currency: type: string amount: type: number format: double description: FeeDetails resource definition. v1UpdateBillingGroupInvoiceServiceDiscountsResponse: type: object properties: id: type: string description: Service discount id. description: Response message for the UpdateBillingGroupInvoiceServiceDiscounts rpc. apiInvoiceMessage: type: object properties: id: type: string title: invoice generate request id status: type: string description: 'done: Invoicing is complete. running: Invoicing in progress. failed: Invoicing is failure.' title: invoice generate request status timestamp: type: string description: status timestamp in UTC, RFC3339. description: InvoiceMessage resource definition. BillingSetBillingGroupInvoiceLayoutConfigBody: type: object properties: layoutId: type: string description: Required. The layout id. v1CreateBillingGroupMergedRequest: type: object properties: billingGroupId: type: string description: Required. The billing group's id. billingGroupName: type: string description: Required. The billing group's name. companyName: type: string title: Required. Company's name billingTitle: type: string title: Optional. The title of the billing phoneNumber: type: string title: Optional. Company's phone number postalCode: type: string title: Optional. Company's postal code address: type: string title: Optional. Company's address personal: type: string title: Optional. Addressee remarks: type: string title: Optional. Any remarks about the billing group projectId: type: string title: Optional. Project code language: type: string title: Optional. Invoice language displayCost: type: string title: Optional. Calculation type, true unblended or unblended exchangeRateType: type: string title: Optional. Exchange rate type, payer or billing group accountOptions: $ref: '#/definitions/v1AccountOptions' description: Optional. Account options. invoices: $ref: '#/definitions/v1CreateBillingGroupRequestInvoice' title: Invoice settings awsOptions: $ref: '#/definitions/billingV1AwsOptions' title: Optional. AWS-specific options city: type: string title: Optional. Company's city prefecture: type: string title: Optional. Company's prefecture country: type: string title: Optional. Company's country invoiceTemplateId: type: string title: Optional. Invoice template ID to associate with the billing group tagSettings: type: array items: type: object $ref: '#/definitions/v1TagSetting' title: Optional. Tag settings for the billing group nonTagSetting: $ref: '#/definitions/v1NonTagSetting' title: Optional. Non-tag setting for the billing group vendorAccounts: type: array items: type: object $ref: '#/definitions/v1VendorAccounts' customFields: type: object additionalProperties: type: string title: Optional. Custom fields to add to the billing group azureOptions: $ref: '#/definitions/billingV1AzureOptions' description: Request message for the CreateBillingGroupMerged rpc. v1GetBillingGroupAccountSupportPlanResponse: type: object properties: id: type: string description: The billing internal id. vendor: type: string description: At the moment, `aws` is supported. enabled: type: boolean description: The enabled indicates whether the account support plan is enabled or disabled. setting: type: array items: type: object $ref: '#/definitions/v1BillingGroupAccountSupportPlan' description: The support plan setting. [blueapi.api.ripple.v1.BillingGroupAccountSupportPlan]. description: Response message for the GetBillingGroupAccountSupportPlan rpc. v1GetCustomizedBillingServiceBillingGroupResponse: type: object properties: id: type: string title: Required. [blueapi.api.ripple.CustomizedBillingService.id] vendor: type: string description: Required. vendor that applied to the CustomizedBillingService config. chargingTarget: $ref: '#/definitions/rippleChargingTarget' title: Required. [blueapi.api.ripple.ChargingTarget] accounts: type: array items: type: object $ref: '#/definitions/blueapiApiAccount' description: Optional. accounts that applied to the CustomizedBillingService config. description: 'Response message for the Billing.GetCustomizedBillingServiceBillingGroup rpc. If there is no account information, it indicates that it is applied to BillingGroup.' required: - id - vendor - chargingTarget v1ChildBillingGroupInvoiceSettings: type: object properties: aws: $ref: '#/definitions/v1BillingGroupVendoredInvoiceSetting' title: AWS invoice settings accountSupportPlanEnabled: type: boolean accountSupportPlanSettings: type: array items: type: object $ref: '#/definitions/v1BillingGroupAccountSupportPlan' description: Optional. Only required when accountSupportPlanEnabled is true. BillingAllocateAdjustmentEntryBody: type: object properties: config: type: array items: type: object $ref: '#/definitions/AllocateAdjustmentEntryRequestAccountConfig' description: Required. accountForRemaining: type: string title: Required. accountId description: Request message for the Billing.AllocateAdjustmentEntry rpc. required: - config - accountForRemaining BillingCreateCustomFeeBody: type: object properties: month: type: string description: Required. The billing month. Format is `yyyymm`. entries: type: array items: type: object $ref: '#/definitions/v1CustomFeeEntry' description: Required. The fee entries to create. description: Request message for the Billing.CreateCustomFee rpc. required: - month - entries blueapiBillingV1ListExchangeRatesResponse: type: object properties: month: type: string description: The Month. common: $ref: '#/definitions/rippleCommonExchangeRate' description: The common exchange rate. billingGroup: type: array items: type: object $ref: '#/definitions/rippleBillingGroupExchangeRate' description: The billing group exchange rate. payer: $ref: '#/definitions/rippleVendorPayerExchangeRate' description: The payer exchange rate. description: Response message for the ListExchangeRates rpc. BillingUpdateCustomFieldBody: type: object properties: key: type: string description: type: string v1CreateAccountInvoiceServiceDiscountsResponse: type: object properties: accounts: type: array items: type: object $ref: '#/definitions/v1AccountServiceDiscounts' description: Response message for the CreateAccountInvoiceServiceDiscounts rpc. v1UpdateChildBillingGroupResponse: type: object v1ExportAccountInvoiceServiceDiscountsRequest: type: object properties: format: type: string description: Required. At the moment, `CSV` is supported. language: type: string description: "Optional. At the moment, `ja`,`en` is supported.\n\nUsually the language of the user information is used, \nbut it may be a different language due to cahce.\nIn that case, you can use this option to change the language of CSV." directLink: type: boolean title: Returns a directLink if set to true description: Request message for the ExportAccountInvoiceServiceDiscounts rpc. required: - format v1ReadInvoiceLayoutConfigRequest: type: object v1AccountServiceDiscountsExport: type: object properties: data: $ref: '#/definitions/v1ExportData' directLink: type: string title: Empty if direct link in request is disabled in request description: 'AccountServiceDiscountsExport resource definition. data is [blueapi.api.ripple.v1.ExportData] content. Base64 encoded value. For example, content :`YmlsbGluZ0dyb3VwSWQsYmlsbGluZ0dyb3VwTmFtZSxWZW5kb3IsQWNjb3VudElkLEFjY291bnROYW1lLFNlcnZpY2UgUHJlbWl1bXMmRGlzY291bnRzDQo=` Decoding this value by en, get `billingGroupId,billingGroupName,Vendor,AccountId,AccountName,Service Premiums&Discounts`. content :`6KuL5rGC44Kw44Or44O844OXSUQs6KuL5rGC44Kw44Or44O844OX5ZCNLOODmeODs+ODgOODvCzjgqLjgqvjgqbjg7Pjg4hJRCzjgqLjgqvjgqbjg7Pjg4jlkI0s44K144O844OT44K55Ymy5byV44O75Ymy5aKX6Kit5a6aDQo=` Decoding this value by ja, get `請求グループID,請求グループ名,ベンダー,アカウントID,アカウント名,サービス割引・割増設定`. downloadedRows. Downloaded content lines. totalRows.Total of content lines.' rippleRounding: type: object properties: rounding: $ref: '#/definitions/RoundingRoundingMethod' description: The rounding method. description: Rounding resource definition. apiConfigFilters: type: object properties: andFilters: type: object additionalProperties: type: string description: 'ConfigFilters resource definition. A map of "key:value" config filters. The key indicates the adjustment key while the value is the filter adjustment value which can be prefixed by either "eq:" (equal), "re:" (regular expressions based on https://github.com/google/re2), or "!re:" (reverse "re:"). No prefix is the same as "eq:". Multiple map items will use the logical ''and'' operator, e.g. mapfilter1 && mapfilter2 && mapfilter3, etc. For example, if you want to query lineitems with the adjustment `productCode:AmazonEC2`, set to `{"productCode":"AmazonEC2"}`. You can also use regular expressions for adjustment values, such as `{"description":"re:[A-Za-z0-9]*"}`. List of available adjustment keys: productCode, type, description For example value on productCode: AmazonEC2, AmazonRDS, AWSLambda, etc. For example value on type: Fee, Refund, SppDiscount, etc.' BillingCreateInvoiceBody: type: object properties: vendor: type: string description: Required. At the moment, only `aws` is supported. allGroups: type: boolean description: 'Optional. You can set all billing groups. If this parameter is not set, The list set to `groups` is used.' groups: type: array items: type: string title: Optional. You can set it to a list of billing internal group id description: Request message for the CreateInvoice rpc. BillingCreateAdjustmentConfigBody: type: object properties: config: type: array items: type: object $ref: '#/definitions/apiConfigFilters' description: "Required. \nA list of filtering options. See [api.ConfigFilters] for more information on each filter item. Multiple filter items will use the logical 'or' operator, e.g. filter1 || filter2 || filter3, etc." accounts: type: array items: type: object $ref: '#/definitions/apiManagementAccount' description: Optional. description: Request message for the Billing.CreateAdjustmentConfig rpc. v1TagSetting: type: object properties: customerId: type: string title: Customer ID tags: type: array items: type: object $ref: '#/definitions/billingV1Tag' title: Tags associated with this customer title: Settings for a specific customer account for AddTagsToBillingGroup billingV1TagData: type: object properties: customerId: type: string accountId: type: string customerName: type: string tags: type: array items: type: object $ref: '#/definitions/v1Tags' title: Response for tag request rippleTieredPercentage: type: object properties: tiredConfig: type: array items: type: object $ref: '#/definitions/rippleTierdConfig' service: $ref: '#/definitions/rippleTargetServiceConfig' usage: $ref: '#/definitions/rippleTargetUsageConfig' discounted: type: boolean title: tired percentage v1RegisterAccounts: type: object properties: enabled: type: boolean description: 'Optional. If enabled, any additional accounts will be automatically enrolled into the billing group. If disabled, register the account manually. For GCP, Register projectId under the specific Sub billing account. For AWS, Register accountId under the specific payer account into the billing group' accountId: type: string description: 'Optional. AccountIds to be used for registration into the billing group. Accepts multiple accountIds separated by a comma. Comma separated accountId are only available for aws.' unLinkOnRemove: type: boolean description: 'Optional. Only available for aws. If true all link accounts under the previously registered payer that are no longer included in the accountId field will be also removed from this billing group. This field is only applicable for RPC request not on response.' title: Register Accounts definition rippleheaderInvoiceLayout: type: object properties: billingAddress: type: string title: 'The billingAddress is information of billing address. ex)HEAD_BILLINGADDRESS: billing"' billingGroupName: type: boolean title: 'The billingGroupName is setting for billing group name. ex)HEAD_BILLINGGROUPNAME: true' billingGroupStaff: type: boolean title: 'The billingGroupStaff is setting for billing froup staff. ex)HEAD_BILLINGGROUPSTAFF: true' companyAddress: type: boolean title: 'The companyAddress is setting for company address. ex)HEAD_COMPANY_ADDRESS: true' companyName: type: boolean title: 'The companyName is setting for company name. ex)HEAD_COMPANY_NAME: true' invoiceDate: type: boolean title: 'The invoiceDate is setting for invoice date. ex)HEAD_INVOICE_DATE: true' invoiceDue: type: boolean title: 'The invoiceDue is setting for invoice due. ex)HEAD_INVOICE_DUE: true' invoiceNo: type: boolean title: 'The invoiceNo is setting for invoice No. ex)HEAD_INVOICE_NO: true' invoiceQuantity: type: string title: 'The invoiceQuantity is information of invoice quantity. ex)HEAD_INVOICE_QUANTITY: "1ヶ月分"' invoiceSummary: type: boolean title: 'The invoiceSummary is setting for invoice summary. ex)HEAD_INVOICE_SUMMARY: true' invoiceTitle: type: string title: 'The invoiceTitle is information of invoice title. ex)HEAD_INVOICE_TITLE: "AWSご利用金額"' issueDateText: type: string title: 'The issueDateText is information of issue date text. ex)HEAD_ISSUE_DATE_TEXT: "tested message"' mspInfo: type: boolean title: 'The mspInfo is setting for msp information. ex)HEAD_MSPINFO: true' mspLogo: type: boolean title: 'The mspLogo is setting for msp logo. ex)HEAD_MSPLOGO: true' mspStamp: type: boolean title: 'The mspStamp is setting for msp stamp. ex)HEAD_MSPSTAMP: true' paidText: type: string title: 'The paidText is information of paid text. ex)HEAD_PAID_TEXT: "paid message"' description: 'WORK-IN-PROGRESS: headerInvoiceLayout resource definition.' rippleTargetUsageConfig: type: string enum: - USAGE default: USAGE description: Describes the overall config of a [blueapi.api.ripple.MethodConfig]. apiKeyValue: type: object properties: key: type: string value: type: string billingV1AccessGroup: type: object properties: accessGroupId: type: string description: The ID of the access group. accessGroupName: type: string description: The name of the access group. accessGroupDescription: type: string description: A description of the access group. billingGroups: type: array items: type: object $ref: '#/definitions/billingV1BillingGroup' description: A list of billing groups contained in the access group. description: Defines the fields associated with a Wave access group. v1UpdateExcludeServiceEntryResponse: type: object properties: entry: $ref: '#/definitions/v1ExcludeServiceEntry' description: The updated exclude service entry. BillingReadUntaggedGroupsBody: type: object properties: fieldMask: type: string description: 'Optional. Get only the value that set fieldMask. see more info: https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/field_mask.proto' description: Request message for the Billing.ReadUntaggedGroups rpc. v1VendorAccounts: type: object properties: vendor: type: string title: Required. (aws, azure, gcp) accounts: type: array items: type: object $ref: '#/definitions/v1AccountToAdd' title: Required. List of accounts to be added to the billing group title: Optional. Vendor accounts to add to the billing group apiCostTag: type: object properties: id: type: string description: The costtag id. orgId: type: string description: The parent organization id. billingInternalId: type: string description: The parent billing internal id. vendor: type: string description: The vendor. accountId: type: string description: The account id. logic: type: string title: The logic.(and/or) tags: type: array items: type: object $ref: '#/definitions/apiKeyValue' description: The attributes (key/value pair) of the costtag. v1InvoiceConnectedBillingGroups: type: object properties: billingInternalId: type: string billingGroupId: type: string billingGroupName: type: string title: Response message to be used for ListInvoiceTemplateResponse ripplePayerExchangeRate: type: object properties: payerAccountId: type: string description: The payer account Id. payerAccountName: type: string description: The payer account Name. exchangeRate: type: array items: type: object $ref: '#/definitions/rippleExchangeRate' description: The exchange rate. description: PayerExchangeRate resource definition. BillingUpdateInvoiceServiceDiscountsBody: type: object properties: invoiceServiceDiscounts: $ref: '#/definitions/apiRippleV1InvoiceServiceDiscounts' description: Required. The updated invoice service discounts object. updateMask: type: string description: 'Required. Indicates which fields in the provided InvoiceServiceDiscounts to update. Must be specified and non-empty.' description: Request message for the Billing.UpdateInvoiceServiceDiscounts rpc. required: - invoiceServiceDiscounts - updateMask apiAdjustmentConfig: type: object properties: config: type: array items: type: object $ref: '#/definitions/apiConfigFilters' title: User configuration vendor: type: string title: Vendor accounts: type: array items: type: object $ref: '#/definitions/apiManagementAccount' title: Management account configuration description: AdjustmentConfig resource definition. v1CreateAccessGroupRequest: type: object properties: name: type: string description: 'Required. access group name. We recommend the name length of 1~60 characters.' description: type: string description: 'Required. access group description. We recommend the description length of 0~150 characters.' billingGroups: type: array items: type: string description: 'Required. Billing group to be included in the access group. You can only include billing groups with the same calculation type and currency type. Specify the billingInternalIds. For example: [`billingInternalId1`,`billingInternalId2`,`billingInternalId3`]' description: Request message for the CreateAccessGroup rpc. v1TagsAddingSetting: type: object properties: groupId: type: string customerId: type: string tagKeys: type: array items: type: string v1CreateCustomFeeResponse: type: object properties: created: type: integer format: int32 description: The number of entries successfully created. description: Response message for the Billing.CreateCustomFee rpc. protobufAny: type: object properties: '@type': type: string description: "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics." additionalProperties: {} description: "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(&foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := &pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := &pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": ,\n \"lastName\": \n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }" apiAccountTotal: type: object properties: name: type: string currency: type: string amount: type: number format: double description: AccountTotal resource definition. v1GetChildBillingGroupResponse: type: object properties: details: $ref: '#/definitions/v1ChildBillingGroup' v1ListBillingGroupCustomFieldRequest: type: object properties: groupId: type: string title: 'billing group InternalID leave empty to get all group id custom field' BillingReadServiceDiscountsServicesBody: type: object description: Request message for the ReadServiceDiscountsServices rpc. v1CreateBillingGroupRequest: type: object properties: billingGroupId: type: string description: Required. The billing group's id. billingGroupName: type: string description: Required. The billing group's name. companyName: type: string title: Required. Company’s name billingTitle: type: string title: Optional. The title of the billing phoneNumber: type: string title: Optional. Company’s phone number postalCode: type: string title: Optional. Company’s postal code address: type: string title: Optional. Company’s address personal: type: string title: Optional. Addressee remarks: type: string title: Optional. Any remarks about the billing group projectId: type: string title: Optional. Project code language: type: string title: Optional. Invoice language displayCost: type: string title: Optional. Calculation type, true unblended or unblended exchangeRateType: type: string title: Optional. Exchange rate type, payer or billing group accountOptions: $ref: '#/definitions/v1AccountOptions' description: Optional. Account options. invoices: $ref: '#/definitions/v1CreateBillingGroupRequestInvoice' title: Invoice settings awsOptions: $ref: '#/definitions/billingV1AwsOptions' title: Optional. AWS-specific options city: type: string title: Optional. Company's city prefecture: type: string title: Optional. Company's prefecture country: type: string title: Optional. Company's country invoiceLayoutConfigId: type: string description: Optional. Invoice Layout Config Id. description: Request message for the Billing.CreateBillingGroup rpc. rippleTargetServiceConfig: type: string enum: - ALL default: ALL description: Describes the overall config of a [blueapi.api.ripple.MethodConfig]. v1CreateExcludeServiceEntryRequest: type: object properties: mspId: type: string description: MSP (Managed Service Provider) ID. Partition key for the exclude service entry. vendor: type: string description: Cloud vendor (e.g., "aws", "gcp"). payerId: type: string description: Payer/account ID to exclude. Use "all" or "*" to apply to all accounts. service: type: string description: Cloud service name (e.g., "EC2", "BigQuery"). product: type: string description: Product or SKU code (used for GCP or detailed exclusions). exceptPayerId: type: array items: type: string description: List of payer IDs to be excepted from exclusion (used when payer_id is "all"). v1CreateInvoiceServiceDiscountsRequest: type: object properties: name: type: string title: Required. [blueapi.api.ripple.v1.InvoiceServiceDiscounts.name] description: type: string title: Optional. [blueapi.api.ripple.v1.InvoiceServiceDiscounts.description] setting: $ref: '#/definitions/v1InvoiceServiceDiscountsSetting' title: Required. [blueapi.api.ripple.v1.InvoiceServiceDiscounts.InvoiceServiceDiscountsSetting] description: Request message for the Billing.CreateInvoiceServiceDiscounts rpc. v1ChildBillingGroup: type: object properties: basicInformation: $ref: '#/definitions/v1ChildBillingGroupBasicInformation' description: Required. Basic information for the child billing group. invoiceSettings: $ref: '#/definitions/v1ChildBillingGroupInvoiceSettings' description: Required. Invoice settings for the child billing group. billingInfo: $ref: '#/definitions/rippleBillingGroupInfo' description: Required. Billing info for the child billing group. hasChild: type: boolean description: 'Indicates whether this child billing group has another child under it. AccountInvoiceServiceDiscounts serviceDiscounts = 3;' description: Contains basic information and invoice settings related data. BillingUpdateBillingGroupInvoiceTemplateBody: type: object properties: invoiceTemplateId: type: string title: Required. The invoice template ID to associate with the billing group title: Request a message to update/create a billing group's invoice template required: - invoiceTemplateId v1ConvertInvoiceToPdfResponse: type: object properties: progress: type: string downloadUrl: type: string title: 'returns "" when not ready returns the direct download link' v1UpdateExcludeServiceEntryRequest: type: object properties: mspId: type: string description: MSP (Managed Service Provider) ID. Partition key for the exclude service entry. vendor: type: string description: Cloud vendor (e.g., "aws", "gcp"). payerId: type: string description: Payer/account ID to update. Use "all" or "*" to apply to all accounts. service: type: string description: Cloud service name (e.g., "EC2", "BigQuery"). product: type: string description: Product or SKU code (used for GCP or detailed exclusions). exceptPayerId: type: array items: type: string description: List of payer IDs to be excepted from exclusion (used when payer_id is "all"). v1AddAccountToBillingGroupRequest: type: object properties: groupId: type: string title: Required. BillingGroupInternalId vendor: type: string title: Required. (aws, azure, gcp) accounts: type: array items: type: object $ref: '#/definitions/v1AccountToAdd' title: Required. List of accounts to be added to the billing group v1GroupServiceDiscountsExport: type: object properties: data: $ref: '#/definitions/v1ExportData' directLink: type: string title: Empty if direct link in request is disabled in request description: 'GroupServiceDiscountsExport resource definition. `Group` refer to `BillingGroup`. data is [blueapi.api.ripple.v1.ExportData] content. Base64 encoded value. For example, content :`YmlsbGluZ0dyb3VwSWQsYmlsbGluZ0dyb3VwTmFtZSxTZXJ2aWNlIFByZW1pdW1zJkRpc2NvdW50cw0K` Decoding this value by en, get `billingGroupId,billingGroupName,Service Premiums&Discounts`. content :`6KuL5rGC44Kw44Or44O844OXSUQs6KuL5rGC44Kw44Or44O844OX5ZCNLOOCteODvOODk+OCueWJsuW8leODu+WJsuWil+ioreWumg0K` Decoding this value by ja, get `請求グループID,請求グループ名,サービス割引・割増設定`. downloadedRows. Downloaded content lines. totalRows.Total of content lines.' v1GetBillingGroupInvoiceLayoutConfigResponse: type: object properties: layout: $ref: '#/definitions/rippleInvoiceLayout' id: type: string description: Layout id. name: type: string description: Layout name. BillingListAdjustmentEntryItemsBody: type: object properties: month: type: string description: Required. The billing month. Format is `yyyymm`. mobingiType: type: string description: 'Optional. Filter by entry type (mobingi_type column). If not specified, returns all adjustment entry items.' status: type: string description: 'Optional. Filter by apply status. "applied" returns entries where apply=true, "pending" returns entries where apply=false. If empty, returns all entries regardless of status.' description: Request message for the Billing.ListAdjustmentEntryItems rpc. required: - month v1UpdateChildBillingGroupInvoiceSettingsResponse: type: object v1AdjustmentEntrySetting: type: object properties: apply: type: boolean description: Applied to the billing. exchangeRate: type: number format: double description: The exchange rate applied to the billing. taxFree: type: boolean description: The tax free applied to the billing. allocateType: type: string description: The allocate type indicates the type to which an entry has been allocated. splitType: type: string description: The split type indicates the type to which an entry has been splitted. originalId: type: string description: The original ID represents the originally allocated or splitted ID. splitted: type: boolean description: The Splitted indicates whether it has been split. term: type: integer format: int32 description: 'The term indicates the number of years that can be splitted. For 1 year, it is divided into 12 parts. For 3 years, it is divided into 36 parts.' description: AdjustmentEntrySetting resource definition. v1ReadChildBillingGroupsRequest: type: object properties: rootId: type: string description: 'Root parent Id. If not empty return all child billing group under the root parent. If both root and parent are empty returns all child billing groups under the MSP.' parentId: type: string description: "Parent Id. If not empty return all child billing group under the parent only, \nIf both root and parent are empty returns all child billing groups under the MSP." v1AdjustmentEntryItem: type: object properties: entry: $ref: '#/definitions/v1AdjustmentEntry' description: The standard adjustment entry fields (id, account info, entry info, settings). meta: type: object additionalProperties: type: string description: Additional metadata as key-value pairs. description: An adjustment entry item with additional metadata for the Guaranteed Commitment Entries UI. BillingSetGlobalExchangeRateBody: type: object properties: currency: type: string title: Required. currency. (e.g. usd, jpy, myr, idr) exchangeRate: type: number format: double title: 'Required. exchangerate. the value of 1 usd per currency above Example: If the invoice currency is "jpy" and 1 USD = 150 jpy, exchangeRate = 150' description: Request message for SetGlobalExchangeRate rpc. v1InvoiceServiceDiscountsSettingDetails: type: object properties: code: type: string title: 'The vendor service code. aws: ProductCode azure: ServiceCode gcp: ServiceName `otherServices`: The code to specify other services as a whole, regardless of vendor. For exmaple: Other services set at 1%. {"code":"otherServices", "value":0.01}' name: type: string description: The vendor service name. readOnly: true value: type: number format: double description: Value associated with the set premiums or discounts. calculationScope: type: boolean description: 'The calculation scope. default is `disabled`. If enabled, Usage and any lineitem type including Fee are included in the calculation. If disabled, only the Usage is included in the calculation.' description: InvoiceServiceDiscountsSettingDetails resource definition. required: - code rippleAssignedBillingGroup: type: object properties: id: type: string description: The unique id of the billing group internal. groupId: type: string description: The unique id of the billing group. groupName: type: string description: The name of the billing group. accounts: type: array items: type: object $ref: '#/definitions/blueapiApiAccount' description: A list of accounts. assigned: $ref: '#/definitions/rippleAssigned' title: The assigned that rules set for untagged groups description: AssignedBillingGroup resource definition. BillingUpdateAccountInvoiceServiceDiscountsBody: type: object properties: accounts: type: array items: type: object $ref: '#/definitions/v1AccountServiceDiscounts' description: Required. description: Request message for the UpdateAccountInvoiceServiceDiscounts rpc. billingV1AzureOptions: type: object properties: resourceGroup: type: boolean title: Whether to use resource groups applyPcEarnedCredit: type: boolean title: Whether to apply partner-earned credit applyCampaignPricing: type: boolean title: Whether to apply campaign pricing title: Optional. Azure-specific options v1AdjustmentEntryInfo: type: object properties: calculationType: type: string description: The calculation type. adjustmentEntryType: type: string description: The adjustment entry type. description: type: string description: The adjustment entry description. productCode: type: string description: The product code. productName: type: string description: The product name. currency: type: string description: The currency. amount: type: number format: double description: The amount. timeInterval: type: string description: The time interval. usageStart: type: string description: The usage start. description: AdjustmentEntryInfo resource definition. ripplereportInvoiceLayout: type: object properties: sectionEnable: type: string title: 'The sectionEnable is setting for section. ex)REPORT_SECTION_ENABLE: "{ \"ja\": true, \"en\": true }"' description: 'WORK-IN-PROGRESS: headerInvoiceLayout resource definition.' BillingUpdateInvoiceExchangeRateBody: type: object properties: vendor: type: string title: Required. vendor (aws, gcp, or azure) exchangeRate: type: object additionalProperties: type: number format: double title: 'Required. Map of currency code to exchange rate value per USD ex. jpy:100' groupIds: type: array items: type: string title: Required. Billing group id to apply v1BillingGroupCustomField: type: object properties: value: type: string customField: $ref: '#/definitions/v1CustomField' ApplyAdjustmentEntryRequestApplySetting: type: object properties: month: type: string description: Optional. apply to month. The UTC month to query. If empty, defaults to current month. Format is `yyyymm`. For example, June 2021 will be `202106`. taxFree: type: boolean description: Optional. tax free setting. exchangeRate: type: object additionalProperties: type: number format: double description: "Optional. exchange rate. \n\nAt the moment, only `jpy`,`idr`,`myr`,`sgd`,`inr` is supported.\nIt will be configured according to the currency type of the billing group associated with the account.\nFor example: {\"jpy\":150.01, \"idr\":16580,\"myr\":4.4,\"sgd\":1.33,\"inr\":85.3}" billingInternalId: type: string description: 'Optional. apply to billing internal ID. When you specify billing internal ID, the invoicing will be applied to the target Billing Group. At the moment, only `aws` is supported.' title: AdjustmentSetting apiAdditionalItems: type: object properties: label: type: string unitCost: type: number format: double total: type: number format: double quantity: type: number format: double description: AdditionalItems resource definition. v1ListInvoiceServiceDiscountsRequest: type: object description: Request message for the ListInvoiceServiceDiscounts rpc. BillingUpdateBillingGroupResellerChargesBody: type: object properties: invoiceTemplate: type: string invoice: $ref: '#/definitions/v1CreateBillingGroupRequestInvoice' v1ExportData: type: object properties: content: type: string description: Base64 encoded value. downloadedRows: type: string format: int64 description: Downloaded content lines. totalRows: type: string format: int64 description: Total of content lines. description: ExportData resource definition. v1CreateExcludeServiceEntryResponse: type: object properties: entry: $ref: '#/definitions/v1ExcludeServiceEntry' description: The created exclude service entry. BillingSetCustomizedBillingServiceBillingGroupBody: type: object properties: setting: type: array items: type: object $ref: '#/definitions/v1SetCustomizedBillingServiceBillingGroupRequestCustomizedBillingServiceBillingSetting' description: Required. customized billing service setting. description: Request message for the Billing.SetCustomizedBillingServiceBillingGroup rpc. required: - setting blueapiApiAccount: type: object properties: vendor: type: string title: The vendor id: type: string description: The account id. name: type: string description: The account name. orgId: type: string description: The parent organization id. billingInternalId: type: string description: The parent billing internal id. metadata: type: array items: type: object $ref: '#/definitions/apiKeyValue' description: The attributes (key/value pair) of the account. BillingGetInvoiceBody: type: object properties: groupId: type: string description: 'Required. For Ripple, only billing internal ids are supported at the moment. You can set it to a single group Implied as the parent billing group for Wave(Pro) users.' description: Request message for the Cost.GetInvoiceRequest rpc. v1BulkTagBillingGroupRequest: type: object properties: csvContent: type: string format: byte title: 'Required. The CSV file content as bytes. Expected columns: billing_group_id, customer_id, key, value' mode: type: string description: 'Optional. The operation mode. One of: "add" (default), "delete", "dry-run".' description: Request for BulkTagBillingGroup. rippleBillingGroupExchangeRate: type: object properties: billingInternalId: type: string description: The billing group's internal id. billingGroupId: type: string description: The billing group's id. billingGroupName: type: string description: The billing group's name. exchangeRate: type: array items: type: object $ref: '#/definitions/rippleExchangeRate' description: The exchange rate. description: BillingGroupExchangeRate resource definition. v1AccountToAdd: type: object properties: customerId: type: string title: Required. account id of the customer accountId: type: string title: Required. Payer account id name: type: string title: Required. Descriptive name note: type: string title: Optional. Addition description or notes title: New message for account details v1ReadCustomizedBillingServicesRequest: type: object properties: fieldMask: type: string description: 'Optional. Get only the value that set fieldMask. see more info: https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/field_mask.proto' description: Request message for the Billing.ReadCustomizedBillingServices rpc. v1CreateResellerRequest: type: object properties: groupId: type: string description: Required. You can set billing internal id or access group id. email: type: string description: Required. password: type: string description: 'Required. We recommend a password length of 8~32 characters. If you send 0 characters, a password will be generated automatically.' notification: type: boolean description: Required. If valid, you will be notified via email address. waveConfig: type: array items: type: object $ref: '#/definitions/rippleResellerConfig' title: Optional. Feature Config. If not set config value, use default config aquaConfig: type: array items: type: object $ref: '#/definitions/rippleResellerConfig' title: Optional. Feature Config. If not set config value, use default config description: Request message for the CreateReseller rpc. v1BulkCreateBillingGroupRequest: type: object properties: vendor: type: string description: 'Required. The cloud vendor for all billing groups in this CSV. Must be one of: aws, azure, gcp.' csvContent: type: string format: byte description: Required. The CSV file content as bytes. delimiter: type: string description: Optional. The delimiter used in the CSV file. Defaults to comma (,). hasHeader: type: boolean description: Optional. Whether the CSV file has a header row. Defaults to true. dryRun: type: boolean description: 'Optional. If true, validate the CSV and check for errors without actually creating billing groups. Useful for validating CSV format and data before performing the actual bulk creation.' v1CreateBillingGroupRequestInvoiceVendor: type: object properties: calcType: type: string discountRate: type: number format: double substitutionFee: type: string substitutionFix: type: number format: double substitutionRate: type: number format: double supportFee: type: string supportRate: type: number format: double supportFix: type: number format: double taxRate: type: number format: double currency: type: string discountTargetUsage: type: string substitutionFeeTargetUsage: type: string discountCalcLogic: type: string substitutionFeeCalcTarget: type: string substitutionFeeCalcType: type: string supportAmountTarget: type: string supportFeeCalcTarget: type: string supportFeeAdjustment: type: number format: double title: Specific settings per vendor rippleaccountInvoiceLayout: type: object properties: marketplace: type: string title: 'The marketplace is name of marketplace usage. ex)ACCT_AWS_MARKETPLACE: "Marketplace利用料金"' marketplaceFee: type: string title: 'The marketplace is name of marketplace fee usage. ex)ACCT_AWS_MARKETPLACE_FEES: "Marketplace 一時金 ご利用金額"' supportFee: type: string title: 'The supportFee is name of support fee usage. ex)ACCT_AWS_SUPPORT_BUSINESS: "AWS保守サービス利用料金"' accountUsage: type: string title: 'The accountUsage is name of account total usage. ex)ACCT_AWS_USAGE: "利用料合計"' accountUsageOnly: type: string title: 'The accountUsageOnly is name of account usage(Only related to vendor). ex)ACCT_AWS_USAGEONLY: "AWS利用料(MarketPlace利用料除く)"' description: 'WORK-IN-PROGRESS: accountInvoiceLayout resource definition.' blueapiBillingV1InvoiceServiceDiscounts: type: object properties: id: type: string description: Service discount id. name: type: string description: Service discount name. description: type: string description: Service discount description. created: type: string description: create timestamp. updated: type: string description: update timestamp. description: Streaming response message for the InvoiceServiceDiscounts rpc. v1GetBillingGroupAnnouncementsResponse: type: object properties: groupId: type: string groupName: type: string companyId: type: string announcements: type: array items: type: object $ref: '#/definitions/v1Announcement' v1ListExcludeServicesResponse: type: object properties: entries: type: array items: type: object $ref: '#/definitions/v1ExcludeServiceEntry' description: List of all exclude service entries for the request. rippleVendorPayerExchangeRate: type: object properties: aws: type: array items: type: object $ref: '#/definitions/ripplePayerExchangeRate' gcp: type: array items: type: object $ref: '#/definitions/ripplePayerExchangeRate' azure: type: array items: type: object $ref: '#/definitions/ripplePayerExchangeRate' description: VendorPayerExchangeRate resource definition. rpcStatus: type: object properties: code: type: integer format: int32 description: The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. message: type: string description: 'A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.' details: type: array items: type: object $ref: '#/definitions/protobufAny' description: 'A list of messages that carry the error details. There is a common set of message types for APIs to use.' description: '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](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).' BillingReadAdjustmentEntriesBody: type: object properties: month: type: string description: Optional. The UTC month to query. If empty, defaults to current month. Format is `yyyymm`. For example, June 2021 will be `202106`. description: Request message for the Billing.ReadAdjustmentEntries rpc. rippleCustomizedBillingService: type: object properties: id: type: string name: type: string description: type: string methodConfig: $ref: '#/definitions/rippleMethodConfig' created: type: string readOnly: true updated: type: string readOnly: true description: CustomizedBillingService resource definition. BillingCreateAccountInvoiceServiceDiscountsBody: type: object properties: accounts: type: array items: type: object $ref: '#/definitions/v1AccountServiceDiscounts' description: Required. description: Request message for the CreateAccountInvoiceServiceDiscounts rpc. v1GetBillingSettingResponse: type: object properties: yearMonth: type: array items: type: object $ref: '#/definitions/rippleYearMonth' description: List of available yearmonth. roundingMethod: $ref: '#/definitions/rippleRounding' description: Rounding method. exportRoundingMethod: $ref: '#/definitions/rippleRounding' description: Rounding method for Export CSV. invoiceLayout: $ref: '#/definitions/rippleInvoiceLayout' description: Invoice layout. invoiceDueDate: $ref: '#/definitions/rippleDueDate' description: Invoice due date. supportCurrency: type: array items: type: string description: List of available currency. description: Response message for the GetBillingSetting rpc. rippleCommonExchangeRate: type: object properties: aws: type: array items: type: object $ref: '#/definitions/rippleExchangeRate' gcp: type: array items: type: object $ref: '#/definitions/rippleExchangeRate' azure: type: array items: type: object $ref: '#/definitions/rippleExchangeRate' description: CommonExchangeRate resource definition. v1CreateChildBillingGroupRequest: type: object properties: basicInformation: $ref: '#/definitions/v1ChildBillingGroupBasicInformation' description: Required. Basic information for the child billing group. billingInfo: $ref: '#/definitions/rippleBillingGroupInfo' description: Optional. If fields are not set, will use values from root billing group. invoiceSettings: $ref: '#/definitions/v1ChildBillingGroupInvoiceSettings' description: Required. Invoice settings for the child billing group. invoiceLayoutConfigId: type: string description: Optional. Invoice layout config id to attach. v1ListServicesResponse: type: object properties: data: type: array items: type: object $ref: '#/definitions/v1ServiceItem' description: List of services. BillingConvertInvoiceToPdfBody: type: object properties: billinggroups: type: array items: type: string title: 'billingInternalId of invoice to download ignored if allBillingGroups is set to true' allBillingGroups: type: boolean title: If true, download all created invoice RoundingRoundingMethod: type: string enum: - ROUND - ROUNDUP - ROUNDDOWN default: ROUND description: "- ROUND: round\n - ROUNDUP: round up\n - ROUNDDOWN: round down" title: RoundingMethod v1AccountInvoiceServiceDiscounts: type: object properties: id: type: string description: Service discount id. account: type: string description: Account id. serviceDiscounts: $ref: '#/definitions/apiRippleV1InvoiceServiceDiscounts' description: service discount infomation. description: Streaming response message for the AccountInvoiceServiceDiscounts rpc. v1ListCustomFieldRequest: type: object v1AccountServiceDiscounts: type: object properties: id: type: string description: Service discount id. accountId: type: string description: Account id. v1BillingGroupAdditionalItems: type: object properties: aws: type: array items: type: object $ref: '#/definitions/apiAdditionalItems' title: AWS additional items azure: type: array items: type: object $ref: '#/definitions/apiAdditionalItems' title: Azure additional items gcp: type: array items: type: object $ref: '#/definitions/apiAdditionalItems' title: GCP additional items description: Additional items for a billing group. BillingRestoreAdjustmentEntryBody: type: object properties: entries: type: array items: type: string description: Required. List of AdjustmentEntry IDs. description: Request message for the Billing.RestoreAdjustmentEntry rpc. required: - entries v1GetFreeFormatResponse: type: object properties: groupId: type: string vendor: type: string freeFormat: type: array items: type: object $ref: '#/definitions/v1FreeFormItem' rippleAssigned: type: object properties: percentage: type: integer format: int32 description: Required. This value can be up to 100. fixed: type: integer format: int32 description: Required. description: Assigned resource definition. required: - percentage - fixed BillingUpdateCustomizedBillingServiceBody: type: object properties: customizedBillingService: $ref: '#/definitions/rippleCustomizedBillingService' description: Required. The updated customized billing service object. updateMask: type: string description: 'Required. Indicates which fields in the provided CustomizedBillingService to update. Must be specified and non-empty.' description: Request message for the Billing.UpdateCustomizedBillingService rpc. required: - customizedBillingService - updateMask v1ExportInvoiceSettingCsvResponse: type: object properties: downloadLink: type: string title: 'csv direct download link expires in 10 minutes' description: Response message for the ExportBillingGroupCsv rpc. v1AddBillingGroupCustomFieldRequest: type: object properties: groupId: type: string title: Required. BillingGroupInternalId idToKey: type: object additionalProperties: type: string title: map of customField id to it's key (description) v1AddTagsToBillingGroupRequest: type: object properties: groupId: type: string title: Required. Billing group internal Id vendor: type: string title: Required. Vendor (aws, azure, gcp) settings: type: array items: type: object $ref: '#/definitions/v1TagSetting' title: Tag settings for different customer accounts nonTagSetting: $ref: '#/definitions/v1NonTagSetting' title: Non-tag settings for the billing group BillingCreateInvoiceWithSettingsBody: type: object properties: vendor: type: string description: Required. At the moment, only `aws` is supported. allGroups: type: boolean description: 'Optional. You can set all billing groups. If true the setting would be apply to all group.' groups: type: array items: type: string description: 'Optional. groups to apply the invoices setting this is ignored if allGroups is true.' invoiceSetting: $ref: '#/definitions/billingV1InvoiceSettings' description: Required. Invoice setting. rippleTierdConfig: type: object properties: min: type: number format: double max: type: number format: double value: type: number format: double title: tired config rippleResellerConfig: type: object properties: key: type: string description: 'For Wave The available values are shown below. - Dashboard `dashboardGraph`: Display graph | Default: true `reportFilters`: Display report filters | Default: false - Usage Reports `usageAccount`: Account | Default: true `usageAccountGraph`: Display graph | Default: true `usageAccountMenuAccountEdit`: Edit account name | Default: false `usageAccountMenuBudget`: Display Budget | Default: false `usageAccountMenuBudgetEdit`: Edit Budget | Default: false `usageAccountMenuFeesFee`: Display fee | Default: false `usageAccountMenuFeesCredit`: Display credit | Default: false `usageAccountMenuFeesRefund`: Display refund | Default: false `usageAccountMenuFeesOtherFees`: Display other fees | Default: false `usageReportDownload`: Download report data | Default: true `cost_forecast_tab`: Cost Forecast | Default: true - Cross Tag `usageCrosstag`: Cross Tag | Default: true `usageCrosstagGraph`: Display graph | Default: true - Group `usageGroup`: Group `usageGroupGraph`: Display graph | Default: true - Cost management `riPurchased`: Display purchased RI | Default: true `riUtilization`: Display RI Utilization | Default: false `riRecommendation`: Display RI Recommendations | Default: false `spPurchased`: Display purchased Savings Plans | Default: false - Other `invoice`: Invoice link | Default: false `openApi`: API Access Tokens | Default: false `usersManagement`: Sub-user management | Default: true `invoiceDownloadCsvDiscount`: Enable discount CSV download | Default: false `invoiceDownloadCsvMerged`: Enable merged CSV download | Default: false `aquaLink`: Aqua link | Default: false `waveproReportFilters`: WavePro Report Filters | Default: false `budgetalerts`: WavePro Budget Alerts | Default: false For Aqua The available values are shown below. - Instance Usage Status `aqCoverageRatio`: Coverage Ratio | Default: false - Reservations Management `aqRiManagement`: RI Management | Default: false `aqSpManagement`: SP Management | Default: false - Recommendation `aqRiSpInstances`: RI/SP Instances | Default: false `aqRightSizing`: Right Sizing | Default: false `aqScheduling`: Scheduling | Default: false' title: key value: type: boolean title: value apiVendorDetail: type: object properties: details: type: array items: type: object $ref: '#/definitions/apiAccountDetails' title: 'details: Includes account-by-account details' groupDetails: type: array items: type: object $ref: '#/definitions/apiGroupDetails' description: 'groupDetails: Includes account-by-account details(fee item data).' groupCustomDetails: type: array items: type: object $ref: '#/definitions/apiGroupCustomDetails' description: 'groupCustomDetails: Includes account-by-account details(custom service and additional item data).' total: type: array items: type: object $ref: '#/definitions/apiInvoiceTotal' title: 'total: Includes data on billing totals' settings: $ref: '#/definitions/blueapiApiInvoiceSettings' title: 'settings: Includes settings related to billing' description: VendorDetail resource definition. apiGroupCustomDetails: type: object properties: name: type: string currency: type: string amount: type: number format: double description: GroupCustomDetails resource definition. BillingSetChildBillingGroupCustomizedBillingServiceBody: type: object properties: rootId: type: string description: Required. Root parent Id. setting: type: array items: type: object $ref: '#/definitions/v1SetChildBillingGroupCustomizedBillingServiceRequestCustomizedBillingServiceBillingSetting' description: Required. customized billing service setting. required: - rootId - setting BillingSetChildBillingGroupAccountInvoiceServiceDiscountsBody: type: object properties: accounts: type: array items: type: object $ref: '#/definitions/v1AccountServiceDiscounts' description: Required. v1DeleteChildBillingGroupResponse: type: object AllocateAdjustmentEntryRequestAccountConfig: type: object properties: id: type: string title: Required. accountId amount: type: number format: double description: Required. title: AccountConfig required: - id - amount v1UpdateInvoiceDisplaySettingsRequest: type: object properties: setting: type: object additionalProperties: type: boolean description: Request message for UpdateInvoiceDisplaySettings rpc. v1GetBillingGroupResponse: type: object properties: billingGroup: $ref: '#/definitions/billingV1BillingGroup' description: Response message for the Billing.GetBillingGroup rpc. v1UsageCostsDrift: type: object properties: billingInternalId: type: string billingGroupId: type: string account: type: string snapshot: type: number format: double description: The total costs saved in your invoice. current: type: number format: double description: The current total costs. diff: type: number format: double description: Streaming response message for the Billing.ListUsageCostsDrift rpc. BillingUpdateAnnouncementBody: type: object properties: announcement: $ref: '#/definitions/v1CreateAnnouncementRequest' apiUsageDetails: type: object properties: name: type: string currency: type: string amount: type: number format: double description: UsageDetails resource definition. v1GetChildBillingGroupCustomizedBillingServiceResponse: type: object properties: id: type: string title: Required. [blueapi.api.ripple.CustomizedBillingService.id] vendor: type: string description: Required. vendor that applied to the CustomizedBillingService config. chargingTarget: $ref: '#/definitions/rippleChargingTarget' title: Required. [blueapi.api.ripple.ChargingTarget] accounts: type: array items: type: object $ref: '#/definitions/blueapiApiAccount' description: Optional. accounts that applied to the CustomizedBillingService config. required: - id - vendor - chargingTarget BillingUpdateResellerBody: type: object properties: email: type: string description: Optional. password: type: string description: 'Optional. We recommend a password length of 8~32 characters. If you send 0 characters, a password will be generated automatically.' waveConfig: type: array items: type: object $ref: '#/definitions/rippleResellerConfig' description: 'Set only the config to be changed. For example, If you want to change only dashboardGraph, set `{"waveConfig": [{"key": "dashboardGraph","value": true}]}` as a parameter' title: Optional. wave feature config aquaConfig: type: array items: type: object $ref: '#/definitions/rippleResellerConfig' description: 'Set only the config to be changed. For example, If you want to change only aqRiManagement, set `{"waveConfig": [{"key": "aqRiManagement","value": true}]}` as a parameter' title: Optional. aqua feature config notification: type: boolean description: 'Optional. If valid when email or password is updated, you will be notified via email address. If only waveConfig or aquaConfig is changed, it is ignored.' updateMask: type: string description: Required. description: Request message for the UpdateReseller rpc. required: - updateMask rippleInvoiceLayout: type: object properties: account: $ref: '#/definitions/rippleaccountInvoiceLayout' title: total layout total: $ref: '#/definitions/rippletotalInvoiceLayout' title: total layout body: $ref: '#/definitions/ripplebodyInvoiceLayout' title: body layout footer: $ref: '#/definitions/ripplefooterInvoiceLayout' title: footer layout header: $ref: '#/definitions/rippleheaderInvoiceLayout' title: header layout report: $ref: '#/definitions/ripplereportInvoiceLayout' title: report layout description: 'WORK-IN-PROGRESS: InvoiceLayout resource definition. Definitions related to invoice display.' BillingRestoreAllocateAdjustmentEntryBody: type: object description: Request message for the Billing.RestoreAllocateAdjustmentEntry rpc. apiRippleV1InvoiceServiceDiscounts: type: object properties: id: type: string description: The invoice service discounts id. name: type: string description: 'The invoice service discount name. must be 1-60 characters long.' description: type: string description: 'The invoice service discount description. Maximum 150 characters long.' setting: $ref: '#/definitions/v1InvoiceServiceDiscountsSetting' description: The invoice service discount setting. created: type: string description: Timestamp associated with the created. readOnly: true updated: type: string description: Timestamp associated with the updated. readOnly: true description: InvoiceServiceDiscounts resource definition. v1ResourceAccount: type: object properties: payerId: type: string customerId: type: string registered: type: boolean v1SetChildBillingGroupCustomizedBillingServiceRequestCustomizedBillingServiceBillingSetting: type: object properties: id: type: string title: Required. [blueapi.api.ripple.CustomizedBillingService.id] chargingTarget: $ref: '#/definitions/rippleChargingTarget' title: Required. [blueapi.api.ripple.ChargingTarget] accounts: type: array items: type: string description: 'Optional. if chargingTarget is BILLINGGROUP, `accounts` is set emptty. Specify the accountIds. For example: [`accountId1`,`accountId2`,`accountId3`]' title: CustomizedBillingServiceBillingSetting required: - id - chargingTarget rippleMethodConfig: type: object properties: currency: $ref: '#/definitions/MethodConfigCurrency' chargingMethod: $ref: '#/definitions/MethodConfigChargingMethod' fixedFee: $ref: '#/definitions/rippleFixedFee' percentage: $ref: '#/definitions/ripplePercentage' fixedFeeOrPercentage: $ref: '#/definitions/rippleFixedFeeOrPercentage' TieredPrice: $ref: '#/definitions/rippleTieredPrice' TieredPercentage: $ref: '#/definitions/rippleTieredPercentage' description: MethodConfig resource definition. v1NonTagSetting: type: object properties: include: type: boolean title: Whether non-tag settings are included type: type: string title: Type of non-tag setting ("percentage" or "fixed") amount: type: number format: double title: Amount value (percentage or fixed amount) title: Non-tag settings for a billing group for AddTagsToBillingGroup MethodConfigChargingMethod: type: string enum: - FIXED_FEE - PERCENTAGE - FIXED_FEE_OR_PERCENTAGE - TIERED_PRICE - TIERED_PERCENTAGE default: FIXED_FEE BillingApplyAdjustmentEntryBody: type: object properties: setting: $ref: '#/definitions/ApplyAdjustmentEntryRequestApplySetting' description: Required. ApplySetting. root setting. entries: type: array items: type: string description: 'Required. List of id. Regarding entries that can be included. - Regular entry - Splitted entry - Allocated entry Regarding entries that cannot be included. - Original entry before being split - Original entry before being allocate' description: Request message for the Billing.ApplyAdjustmentEntry rpc. required: - setting - entries CsvSettingColumn: type: object properties: name: type: string id: type: string description: type: string enabled: type: boolean v1GetAccessGroupResponse: type: object properties: accessGroup: $ref: '#/definitions/billingV1AccessGroup' description: Response message for the Billing.GetAccessGroup rpc. v1AwsDailyRunHistoryAccount: type: object properties: accountId: type: string history: type: array items: type: object $ref: '#/definitions/AccountHistory' BillingSetPayerExchangeRateBody: type: object properties: vendor: type: string description: Required. vendor. accountId: type: string description: Required. account(payer) id. currency: type: string title: Required. currency. (e.g. usd, jpy, myr, idr) exchangeRate: type: number format: double title: 'Required. exchangerate. the value of 1 usd per currency above Example: If the invoice currency is "jpy" and 1 USD = 150 jpy, exchangeRate = 150' description: Request message for SetPayerExchangeRate rpc. protosOperation: type: object properties: name: type: string description: The server-assigned name. metadata: $ref: '#/definitions/protobufAny' description: 'Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.' done: type: boolean description: 'If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.' error: $ref: '#/definitions/rpcStatus' description: The error result of the operation in case of failure or cancellation. response: $ref: '#/definitions/protobufAny' description: 'The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.' description: 'This resource represents a long-running operation that is the result of a network API call.' BillingUpdateNonTagGroupToBillingGroupBody: type: object properties: settings: type: array items: type: object $ref: '#/definitions/v1NonTagGroupSetting' title: Required. The settings to update title: Request message for updating non-tag group settings for a billing group for UpdateNonTagGroupToBillingGroup rippleExchangeRate: type: object properties: currency: type: string description: The currency code. rate: type: number format: double description: The rate. description: ExchangeRate resource definition. v1CreateBillingGroupInvoiceServiceDiscountsResponse: type: object properties: id: type: string description: Service discount id. description: Response message for the CreateBillingGroupInvoiceServiceDiscounts rpc. ripplefooterInvoiceLayout: type: object properties: attention: type: string title: 'The attention is name of attention. ex)FT_ATTENTION: null' invoiceBank: type: boolean title: 'The invoiceBank is setting for invoice bank. ex)FT_INVOICE_BANK: true' invoiceBankContent: type: string title: 'The invoiceBankContent is information of invoice bank content. ex)FT_INVOICE_BANK_CONTENT: "振込手数料はご負担ください。"' invoiceMemo: type: boolean title: 'The invoiceMemo is setting for invoice memo. ex)FT_INVOICE_MEMO: true' invoiceRemarks: type: boolean title: 'The invoiceRemarks is setting for invoice remarks. ex)FT_INVOICE_REMARKS: true' invoiceDiscountZero: type: boolean title: 'The invoiceDiscountZero is setting for invoice discount. ex)FT_INVOICE_DISCOUNT_ZERO: true' description: 'WORK-IN-PROGRESS: footerInvoiceLayout resource definition.' v1CreateAnnouncementRequest: type: object properties: label: type: string title: Optional. Label description for the announcement type: type: string title: Required. Announcement type (eg. "info", "urgent") contents: type: string title: Required. Announcement message (HTML format) billingGroups: type: array items: type: string title: Optional. Group Id that the announcement will apply allBillingGroups: type: boolean title: Optional. Apply the announcement to all billing groups start: type: string format: int64 title: Required. Start time for the announcement (epoch time) end: type: string format: int64 title: Required. End time for the announcement (epoch time) status: type: string title: Required. Announcement status ("enabled", "disabled") v1FreeFormItem: type: object properties: label: type: string unitCost: type: string format: int64 total: type: string format: int64 quantity: type: integer format: int64 enabled: type: boolean v1ExportServiceDiscountsRequest: type: object properties: format: type: string description: Required. At the moment, `CSV` is supported. language: type: string description: "Optional. At the moment, `ja`,`en` is supported.\n\nUsually the language of the user information is used, \nbut it may be a different language due to cahce.\nIn that case, you can use this option to change the language of CSV." description: Request message for the ExportServiceDiscounts rpc. required: - format BillingUpdateBillingGroupAdditionalChargesBody: type: object properties: aws: type: array items: type: object $ref: '#/definitions/v1UpdateBillingGroupAdditionalChargesRequestCustomizedBillingServiceBillingSetting' description: Required. customized billing service setting. azure: type: array items: type: object $ref: '#/definitions/v1UpdateBillingGroupAdditionalChargesRequestCustomizedBillingServiceBillingSetting' gcp: type: array items: type: object $ref: '#/definitions/v1UpdateBillingGroupAdditionalChargesRequestCustomizedBillingServiceBillingSetting' required: - aws - azure - gcp BillingUpdateInvoicePreviewsBody: type: object properties: allGroups: type: boolean description: 'Optional. You can set all billing groups. If this parameter is not set, The list set to `groups` is used.' groups: type: array items: type: string title: Optional. You can set it to a list of billing internal group id enabled: type: boolean description: 'Required. You can set display or hiding. If true, Hiding Invoice. If false, Display Invoice.' description: Request message for the UpdateInvoicePreviews rpc. v1CreateFreeFormatRequest: type: object properties: groupId: type: string vendor: type: string items: type: array items: type: object $ref: '#/definitions/v1FreeFormItem' title: 'BillingGroup FreeFormat: Also known as miscellaneous' BillingUpdateBillingGroupAccountSupportPlanBody: type: object properties: enabled: type: boolean description: Optional. The enabled indicates whether the account support plan is enabled or disabled. setting: type: array items: type: object $ref: '#/definitions/v1BillingGroupAccountSupportPlan' description: Optional. The support plan setting. [blueapi.api.ripple.v1.BillingGroupAccountSupportPlan]. updateMask: type: string description: 'Required. If the `enabled` is set, only the `enabled` will be updated. If you want to update all values, please set both `enabled` and `setting`.' description: Request message for the UpdateBillingGroupAccountSupportPlan rpc. required: - updateMask BillingUpdateChildBillingGroupBody: type: object properties: basicInformation: $ref: '#/definitions/v1ChildBillingGroupBasicInformation' description: Required. Basic information for the child billing group. billingInfo: $ref: '#/definitions/rippleBillingGroupInfo' description: Required. Billing info for the child billing group. BillingUpdateAccessGroupBody: type: object properties: name: type: string description: 'Optional. access group name. Set only the name to be changed. We recommend the name length of 1~60 characters.' description: type: string description: 'Optional. access group description. Set only the description to be changed. We recommend the description length of 0~150 characters.' billingGroups: type: array items: type: string description: 'Optional. Billing group to be included in the access group. You can only include billing groups with the same calculation type and currency type. Set only the billingGroups to be changed. Specify the billingInternalIds. For example: [`billingInternalId1`,`billingInternalId2`,`billingInternalId3`]' description: Request message for the UpdateAccessGroup rpc. v1InvoiceServiceDiscountsSetting: type: object properties: awsDetails: type: array items: type: object $ref: '#/definitions/v1InvoiceServiceDiscountsSettingDetails' description: The invoice service discounts setting details. azureDetails: type: array items: type: object $ref: '#/definitions/v1InvoiceServiceDiscountsSettingDetails' description: The invoice service discounts setting details. gcpDetails: type: array items: type: object $ref: '#/definitions/v1InvoiceServiceDiscountsSettingDetails' description: The invoice service discounts setting details. description: InvoiceServiceDiscountsSetting resource definition. billingV1BillingGroup: type: object properties: billingInternalId: type: string description: The billing group's internal id. billingGroupId: type: string description: The billing group id. billingGroupName: type: string description: The billing group name. companyName: type: string description: The company’s name. type: type: string title: 'For aws only: `default` or `imported`' hasChild: type: boolean description: Indicates if this billing group has child billing groups. AWS only for now. billingGroupInfo: $ref: '#/definitions/rippleBillingGroupInfo' title: The billing group info accountOptions: $ref: '#/definitions/v1AccountOptions' description: The account options. accounts: type: array items: type: object $ref: '#/definitions/blueapiApiAccount' title: List of all accounts tags: type: array items: type: object $ref: '#/definitions/apiCostTag' title: List of all tags invoiceSettings: $ref: '#/definitions/v1BillingGroupInvoiceSettings' description: The invoice settings for this billing group. additionalItems: $ref: '#/definitions/v1BillingGroupAdditionalItems' title: List of all additionalItems awsOptions: $ref: '#/definitions/billingV1AwsOptions' title: AWS-specific options v1ServiceItem: type: object properties: id: type: string description: Service ID. code: type: string description: Service code. names: type: array items: type: string description: List of display names for this service. skus: type: array items: type: string description: List of SKU codes under this service. description: Represents a single service with its associated names and SKUs. BillingRestoreSplitAdjustmentEntryBody: type: object description: Request message for the Billing.RestoreSplitAdjustmentEntry rpc. v1CsvSetting: type: object properties: id: type: string name: type: string col: type: array items: type: object $ref: '#/definitions/CsvSettingColumn' rippleDueDate: type: object properties: dueDateDay: type: string description: 'Due date set on the invoice Refer to the following for available values beginning_of_month: The beginning date of the month is automatically set. end_of_month: The end date of the month is automatically set. custom: Date can be specified.' dueDateMonth: type: string description: 'Due month set on the invoice Refer to the following for available values this_month: This month is automatically set. next_month: Next month is automatically set. month_after_next: Month after next is automatically set.' dueDateCustomDay: type: integer format: int32 title: 'Customized due date set on the invoice Range 1 ~ 31' description: DueDate resource definition. v1ListBillingGroupCustomFieldResponse: type: object properties: groupId: type: string billingGroupCustomFields: type: array items: type: object $ref: '#/definitions/v1BillingGroupCustomField' v1UpdateAnnouncementsStatusRequest: type: object properties: announcementId: type: array items: type: string status: type: string BillingListInvoiceStatusBody: type: object description: Request message for the ListInvoiceStatus rpc. v1CreateInvoiceLayoutConfigRequest: type: object properties: name: type: string description: Required. The name of the invoice layout. layout: $ref: '#/definitions/rippleInvoiceLayout' description: Required. The actual invoice layout configs. v1CreateInvoiceLayoutConfigResponse: type: object properties: layoutId: type: string description: The id assigned for this layout. v1CreateChildBillingGroupResponse: type: object BillingUpdateBillingGroupCustomFieldsBody: type: object properties: idToKey: type: object additionalProperties: type: string rippleFixedFeeOrPercentage: type: object properties: fixedFeeValue: type: number format: double percentageValue: type: number format: double service: $ref: '#/definitions/rippleTargetServiceConfig' usage: $ref: '#/definitions/rippleTargetUsageConfig' discounted: type: boolean upperLimit: type: number format: double title: fixed fee or percentage BillingExportInvoiceFileBody: type: object properties: groupId: type: string description: "Optional.\n\nFor Ripple, only billing internal ids are supported at the moment. You can set it to a single group or a comma-separated list of groups. ex) `group1,group2`. if want to set all group, set `*`. \n\nImplied as the parent billing group for Wave(Pro) users." description: Request message for the ExportCostFiltersFile rpc. BillingSetChildBillingGroupInvoiceServiceDiscountsBody: type: object properties: id: type: string description: 'Required. Service discount id.' v1ListAwsDailyRunHistoryRequest: type: object properties: month: type: string description: 'Optional. If empty, defaults to current UTC month. Format: yyyymm.' groupId: type: string description: Optional. If not empty, query for this group. At the moment, only `billingInternalId`s are supported. description: Request message for the Billing.ListAwsCalculationHistory rpc. v1ChildBillingGroupBasicInformation: type: object properties: id: type: string description: Required. Child billing group id that is created by the client. internalId: type: string description: Child billing group internal Id. Required for get and list, optional for create and update. parentId: type: string description: Required. Parent internal Id. rootParentId: type: string description: Required. Root parent internal Id. If parentId and rootParentId are the same, it means this child is the 1st level after root. name: type: string description: Required. Child billing group name. companyName: type: string description: Required. Company name. v1UpdateAccountInvoiceServiceDiscountsResponse: type: object properties: accounts: type: array items: type: object $ref: '#/definitions/v1AccountServiceDiscounts' description: Response message for the UpdateAccountInvoiceServiceDiscounts rpc. apiCustomDetails: type: object properties: name: type: string currency: type: string amount: type: number format: double description: CustomDetails resource definition. MethodConfigCurrency: type: string enum: - JPY - USD - IDR - MYR - SGD - INR default: JPY description: supported currency. apiInvoiceTotal: type: object properties: name: type: string description: "supportFee: \n Total amount of Support Fee costs\n\nsubstitution: \n Total amount of agency fee costs\n\nchargeOnly: \n Total amount of vendor usage fee only costs\n\nmarketplace: \n Total amount of vendor marketplace usage costs\n\nmarketplaceFees: \n Total amount of vendor marketplace fee costs\n\ncharge: \n Total amount of vendor usage fee costs\n\ndiscount: \n Total amount after discounts. Inculuded Support fee costs\n\ndiscountWithSubstitution: \n Total Discounts plus agency fee costs\n\nchargeTaxFree: \n Amounts not included in consumption tax\n\nadditionalItem: \n Total amount of additional item costs \n\ncustomService: \n Total amount of custom service item costs \n\nsumOfBeforeTax: \n Total amount before consumption tax\n\ntax: \n Consumption tax amount on the total amount\n\ntotal: \n Total billing amount including tax" title: Key names related to the total. Each key is described in the following detail currency: type: string amount: type: number format: double description: InvoiceTotal resource definition. v1BillingGroupVendoredInvoiceSetting: type: object properties: calcType: type: string discountRate: type: number format: double substitutionFee: type: string substitutionFix: type: number format: double substitutionRate: type: number format: double supportFee: type: string supportRate: type: number format: double supportFix: type: number format: double taxRate: type: number format: double currency: type: string discountTargetUsage: type: string substitutionFeeTargetUsage: type: string discountCalcLogic: type: string substitutionFeeCalcTarget: type: string substitutionFeeCalcType: type: string supportAmountTarget: type: string supportFeeCalcTarget: type: string supportFeeAdjustment: type: number format: double description: Invoice settings that are vendor-specific for each billing group. v1Credit: type: object properties: id: type: string customerId: type: string customerName: type: string creditAmount: type: number format: double term: type: string description: type: string created: type: string initialFee: type: number format: double creditBalance: type: number format: double applied: type: boolean v1ExportInvoiceFileResponse: type: object properties: url: type: string description: 'Required. URL of exported file. csv columns set `group vendor resourceId resourceName type serviceName currency cost`' description: Response message for the ExportInvoiceFile rpc. v1DeleteExcludeServiceEntryResponse: type: object properties: entry: $ref: '#/definitions/v1ExcludeServiceEntry' description: The deleted exclude service entry (or just status). waveAdjustment: type: object properties: yearMonth: type: string title: Year month feeType: type: string title: Fee type description: type: string title: Description productCode: type: string title: ProductCode productName: type: string title: ProductName usageAccountId: type: string title: UsageAccountId currencyCode: type: string title: CurrencyCode payerAccountId: type: string title: PayerAccountId cost: type: string title: Cost timeInterval: type: string title: TimeInterval usageStartDate: type: string title: UsageStartDate description: Adjustment resource definition. BillingCreateBillingGroupInvoiceServiceDiscountsBody: type: object properties: id: type: string description: 'Required. Service discount id.' description: Request message for the CreateBillingGroupInvoiceServiceDiscounts rpc. BillingUpdateBillingGroupBasicInformationBody: type: object properties: basicInformation: $ref: '#/definitions/v1BasicInformation' BillingSetBillingGroupExchangeRateBody: type: object properties: groupId: type: string description: Required. account(payer) id. currency: type: string title: Required. currency. (e.g. usd, jpy, myr, idr) exchangeRate: type: number format: double title: 'Required. exchangerate. the value of 1 usd per currency above Example: If the invoice currency is "jpy" and 1 USD = 150 jpy, exchangeRate = 150' description: Request message for SetBillingGroupExchangeRate rpc. v1ListInvoiceResponse: type: object properties: billingInternalId: type: string description: The billing internal id. billingGroupId: type: string description: The billing group id. billingGroupName: type: string title: The billing group name. Used as invoice name on ripple v2 companyName: type: string finalizationStatus: type: string isCreated: type: boolean title: invoice creation status isSettingModified: type: boolean createdDate: type: string updatedDate: type: string createdVendors: type: array items: type: string isPublished: type: boolean title: wave publish status vendorBillingAmount: type: object additionalProperties: type: string title: map of vendor to billingAmount Formated in $8,000.12 billingAmountTotal: type: string currency: type: string title: The currency of the invoice (usd, jpy, ...) urlId: type: string createdVendorInvoiceSetting: type: object additionalProperties: $ref: '#/definitions/billingV1InvoiceSettings' title: setting used in invoice creation savedVendorInvoiceSetting: type: object additionalProperties: $ref: '#/definitions/billingV1InvoiceSettings' title: saved invoice setting for the month defaultVendorInvoiceSetting: type: object additionalProperties: $ref: '#/definitions/billingV1InvoiceSettings' title: billinggroup's default invoice setting hasChild: type: boolean description: True if this invoice/company has a child. description: Response message for the ListInvoice rpc. apiAccountDetails: type: object properties: id: type: string description: "Resource Id. \n\nif account, customer id.\n\nif tag, tag resource id." name: type: string description: "Resource Name. \n\nif account, customer name.\n\nif tag, tag resources." details: type: array items: type: object $ref: '#/definitions/apiUsageDetails' title: 'details: Vendor service fees included' customDetails: type: array items: type: object $ref: '#/definitions/apiCustomDetails' title: 'customDetails: Includes details of custom service and additional item data' feeDetails: type: array items: type: object $ref: '#/definitions/blueapiApiFeeDetails' title: 'feeDetails: Includes details of re-caluclated fee data' total: type: array items: type: object $ref: '#/definitions/apiAccountTotal' description: "substitution:\n Total amount of agency fee costs\n\nsupportFee:\n Total amount of Support Fee costs\n\nusageOnlyTotal:\n Total amount of vendor usage fee only costs\n\nusageTotal:\n Total amount of vendor usage fee costs\n\nmarketplace:\n Total amount of vendor marketplace usage costs\n\nmarketplaceFees:\n Total amount of vendor marketplace fee costs" title: The keys included in the account total column have the following values description: AccountDetails resource definition. apiInvoice: type: object properties: aws: $ref: '#/definitions/apiVendorDetail' title: Invoice vendor detail by 'aws' gcp: $ref: '#/definitions/apiVendorDetail' title: Invoice vendor detail by 'gcp' azure: $ref: '#/definitions/apiVendorDetail' title: Invoice vendor detail by 'azure' description: Invoice resource definition. v1ListInvoiceTemplateResponse: type: object properties: id: type: string name: type: string description: type: string created: type: string updated: type: string numberOfConnected: type: integer format: int32 connectedBillingGroup: type: array items: type: object $ref: '#/definitions/v1InvoiceConnectedBillingGroups' invoices: $ref: '#/definitions/v1BillingGroupInvoiceSettings' description: Response message for ListInvoiceTemplate rpc. v1Announcement: type: object properties: id: type: string label: type: string type: type: string message: type: string billingGroups: type: array items: type: string allBillingGroups: type: boolean start: type: string end: type: string date: type: string status: type: string userStatus: type: string created: type: string updated: type: string BillingUpdateBillingGroupInvoiceSettingsBody: type: object properties: billingTitle: type: string calculationType: type: string language: type: string invoiceLayoutConfigId: type: string description: Optional. Invoice Layout Config Id. v1NonTagGroupSetting: type: object properties: id: type: string title: Required. The non-tag group ID type: type: string title: Required. The type of setting (percentage or fixed) amount: type: number format: double title: Required. The amount value for either percentage or fixed amount title: Individual non-tag group setting for UpdateNonTagGroupToBillingGroup v1BasicInformation: type: object properties: billingGroupName: type: string billingGroupId: type: string companyName: type: string addressee: type: string country: type: string postalCode: type: string city: type: string phoneNumber: type: string addressLine1: type: string addressLine2: type: string state: type: string prefecture: type: string v1ReadInvoiceLayoutConfigResponse: type: object properties: id: type: string description: Invoice layout config id. name: type: string description: Invoice layout config name. layout: $ref: '#/definitions/rippleInvoiceLayout' v1CreateBillingGroupRequestInvoice: type: object properties: aws: $ref: '#/definitions/v1CreateBillingGroupRequestInvoiceVendor' title: AWS invoice settings azure: $ref: '#/definitions/v1CreateBillingGroupRequestInvoiceVendor' title: Azure invoice settings gcp: $ref: '#/definitions/v1CreateBillingGroupRequestInvoiceVendor' title: GCP invoice settings title: Vendor invoice setttings v1BillingGroupAccountSupportPlan: type: object properties: id: type: string description: The account id. name: type: string description: The account name. readOnly: true plan: $ref: '#/definitions/v1SupportPlan' description: The support plan. description: Billing Group Account Support Plan resource definition. BillingUpdateChildBillingGroupInvoiceSettingsBody: type: object properties: invoiceSettings: $ref: '#/definitions/v1ChildBillingGroupInvoiceSettings' description: Required. Invoice settings for the child billing group. invoiceLayoutConfigId: type: string description: Optional. Invoice layout config id to attach. v1BulkLinkAccountRequest: type: object properties: vendor: type: string description: 'Required. The cloud vendor for all accounts in this CSV. Must be one of: aws, azure, gcp.' csvContent: type: string format: byte description: Required. The CSV file content as bytes. delimiter: type: string description: Optional. The delimiter used in the CSV file. Defaults to comma (,). hasHeader: type: boolean description: Optional. Whether the CSV file has a header row. Defaults to true. dryRun: type: boolean description: 'Optional. If true, validate the CSV and check for errors without actually linking accounts. Useful for validating CSV format and data before performing the actual bulk operation.' blueapiApiInvoiceSettings: type: object properties: address: type: string groupId: type: string groupName: type: string contact: type: string currency: type: string dueDate: type: string dueDateCustomDay: type: number format: double dueDateDay: type: string dueDateMonth: type: string exchangeRate: type: number format: double invoiceNo: type: string language: type: string phone: type: string postal: type: string title: type: string description: InvoiceSettings resource definition. v1ListBillingGroupsPaginatedResponse: type: object properties: billingGroups: type: array items: type: object $ref: '#/definitions/v1BillingGroupListItem' description: Flattened rows for the billing groups table. totalCount: type: integer format: int32 description: Total count of billing groups matching the filters. currentPage: type: integer format: int32 description: Current page number (1-based). pageSize: type: integer format: int32 description: Current page size. totalPages: type: integer format: int32 description: Total number of pages. description: Response message for the Billing.ListBillingGroupsPaginated rpc. v1GetInvoiceDisplaySettingsResponse: type: object properties: showRISPUpfrontTimeInterval: type: boolean description: Response message for GetInvoiceDisplaySettings rpc. rippleFixedFee: type: object properties: value: type: number format: double title: fixed fee BillingSaveInvoiceSettingsBody: type: object properties: vendor: type: string description: Required. At the moment, only `aws` is supported. allGroups: type: boolean description: 'Optional. You can set all billing groups. If true the setting would be apply to all group.' groups: type: array items: type: string description: 'Optional. groups to apply the invoices setting this is ignored if allGroups is true.' invoiceSetting: $ref: '#/definitions/billingV1InvoiceSettings' description: Required. Invoice setting. v1AccountOptions: type: object properties: aws: $ref: '#/definitions/v1RegisterAccounts' title: AWS register accounts gcp: $ref: '#/definitions/v1RegisterAccounts' title: GCP register accounts azure: $ref: '#/definitions/v1RegisterAccounts' title: Azure register accounts description: Account options definition. v1ExportBillingGroupCsvResponse: type: object properties: downloadLink: type: string title: 'csv direct download link expires in 10 minutes' description: Response message for the ExportBillingGroupCsv rpc. rippleUntaggedGroup: type: object properties: id: type: string description: 'The unique id of the untagged group. Automatically generated.' name: type: string title: Required. The unique name of the untagged group. This value can be up to 60 assigned: $ref: '#/definitions/rippleAssigned' title: Optional. The assigned that rules set for untagged groups billingGroups: type: array items: type: object $ref: '#/definitions/rippleAssignedBillingGroup' description: Optional. created: type: string description: Output only. The time when the `UntaggedGroup` was created. readOnly: true updated: type: string description: Output only. The time when the `UntaggedGroup` was last updated. readOnly: true description: UntaggedGroup resource definition. required: - name v1AdjustmentEntry: type: object properties: id: type: string description: The adjustment entry ID. name: type: string description: The adjustment entry name. account: $ref: '#/definitions/v1AdjustmentEntryAccountInfo' description: Account info. entry: $ref: '#/definitions/v1AdjustmentEntryInfo' description: Adjustment entry info. setting: $ref: '#/definitions/v1AdjustmentEntrySetting' description: Adjustment entry setting. description: AdjustmentEntry resource definition. rippleReseller: type: object properties: id: type: string description: reseller id. Generated automatically. email: type: string title: email groupId: type: string title: groupId includes `billingInternalId` or `accessGroupId` groupName: type: string title: groupName includes `billingInternalName` or `accessGroupName` groupType: type: string description: 'group type Refer to the following for available values billing_group: Billing Group. access_group: Access Group.' waveStatus: type: string title: wave status waveConfig: type: array items: type: object $ref: '#/definitions/rippleResellerConfig' title: wave feature config aquaConfig: type: array items: type: object $ref: '#/definitions/rippleResellerConfig' title: aqua feature config v1CreateCustomizedBillingServiceRequest: type: object properties: name: type: string title: Required. [blueapi.api.ripple.CustomizedBillingService.name] description: type: string title: Optional. [blueapi.api.ripple.CustomizedBillingService.description] config: $ref: '#/definitions/rippleMethodConfig' title: Required. [blueapi.api.ripple.CustomizedBillingService.MethodConfig] description: Request message for the Billing.CreateCustomizedBillingService rpc. v1SetCustomizedBillingServiceBillingGroupRequestCustomizedBillingServiceBillingSetting: type: object properties: id: type: string title: Required. [blueapi.api.ripple.CustomizedBillingService.id] chargingTarget: $ref: '#/definitions/rippleChargingTarget' title: Required. [blueapi.api.ripple.ChargingTarget] accounts: type: array items: type: string description: 'Optional. if chargingTarget is BILLINGGROUP, `accounts` is set emptty. Specify the accountIds. For example: [`accountId1`,`accountId2`,`accountId3`]' title: CustomizedBillingServiceBillingSetting required: - id - chargingTarget BillingUpdateInvoiceLayoutConfigBody: type: object properties: layout: $ref: '#/definitions/rippleInvoiceLayout' description: Required. The new layout values. name: type: string description: Optional. The updated name of this invoice layout config. v1CustomFeeEntry: type: object properties: accountId: type: string description: Required. The linked account ID (customer_id in the fee table sort key). payerAccountId: type: string description: Required. The payer account ID (account_id in the fee table sort key). feeType: type: string description: 'Required. The fee type for the sort key type segment. Determines the main Type column value in Adjusting Entries (e.g., "Fee").' mobingiType: type: string description: 'Required. The entry type stored in the mobingi_type column. Used for filtering and categorization (e.g., "COMMITMENT" for Guaranteed Commitments, "CUSTOM" for Custom Fees). Accepted values: UPFRONT, SUPPORT, REGISTRAR, OTHERS, CREDIT, REFUND, COMMITMENT, CUSTOM.' amount: type: number format: double description: Required. The fee amount (cost). Positive for charges, negative for rebates. currencyCode: type: string description: Required. The currency code (e.g., "USD"). description: type: string description: 'Required. Human-readable description of the fee. For commitment entries: e.g., "Guaranteed Compute Savings Plan - Premium".' productCode: type: string description: Optional. The product/service code (e.g., "aws/savingsplan"). productName: type: string description: Optional. The product/service display name (e.g., "Compute Savings Plan"). usageStart: type: string description: Optional. The usage start time in RFC 3339 format. timeInterval: type: string description: Optional. The time interval in ISO 8601 interval format. meta: type: object additionalProperties: type: string description: 'Optional. Additional metadata as key-value pairs. For Guaranteed Commitment entries, may contain: commitment_id, invoice_id, contract_term, fee_rate, monthly_commitment, monthly_savings, net_savings, utilization, billing_account_id, commitment_display_name, commitment_leased_name, provider, commitment_type.' description: A single custom fee entry to write to the adjustments table. required: - accountId - payerAccountId - feeType - mobingiType - amount - currencyCode - description v1UpdateBillingGroupAdditionalChargesRequestCustomizedBillingServiceBillingSetting: type: object properties: id: type: string title: Required. [blueapi.api.ripple.CustomizedBillingService.id] chargingTarget: $ref: '#/definitions/rippleChargingTarget' title: Required. [blueapi.api.ripple.ChargingTarget] accounts: type: array items: type: string description: 'Optional. if chargingTarget is BILLINGGROUP, `accounts` is set emptty. Specify the accountIds. For example: [`accountId1`,`accountId2`,`accountId3`]' title: CustomizedBillingServiceBillingSetting required: - id - chargingTarget v1AdjustmentEntryAccountInfo: type: object properties: id: type: string description: The account ID. name: type: string description: The account name. vendor: type: string description: The vendor. billingInternalId: type: string description: The billing internal ID. billingGroupId: type: string description: The billing group ID. billingGroupName: type: string description: The billing group name. currency: type: string description: The billing group currency. description: AdjustmentEntryAccountInfo resource definition. BillingListAccountInvoiceServiceDiscountsBody: type: object description: Request message for the ListAccountInvoiceServiceDiscounts rpc. BillingListUsageCostsDriftBody: type: object properties: billingInternalId: type: string description: Optional. If empty, returns all billing groups. month: type: string description: 'Optional. If empty, defaults to current UTC month. Format: yyyymm.' description: Request message for the Billing.ListUsageCostsDrift rpc. BillingUpdateBillingGroupLinkedResourcesBody: type: object properties: vendor: type: string selectionMethod: type: string accounts: type: array items: type: object $ref: '#/definitions/v1AccountToAdd' title: Account settings settings: type: array items: type: object $ref: '#/definitions/v1TagSetting' title: Tag settings for different customer accounts nonTagSetting: $ref: '#/definitions/v1NonTagSetting' title: Non-tag settings for the billing group accountOptions: $ref: '#/definitions/v1AccountOptions'