openapi: 3.0.1 info: contact: email: support@suger.io name: Suger Support url: https://www.suger.io/support description: CRUD operations on a set of resources, including organizations, products, offers, entitlements, usage record groups for meterting, etc. title: Suger API version: '1.0' servers: - url: https://api.suger.cloud tags: - description: Access to API client resources name: API - description: Access to Billing resources, such as addon, invoice, payment, etc. name: Billing - description: Access to Buyer resources name: Buyer - description: Access to Contact resources name: Contact - description: Access to Entitlement resources name: Entitlement - description: Access to Usage Metering resources name: Metering - description: Access to Notification resources name: Notification - description: Access to Offer resources name: Offer - description: Access to Product resources name: Product - description: Access to revenue or usage metering Report resources name: Report - description: Access to Suger Support ticket resources name: Support paths: /org/{orgId}/addon: get: description: List all addon templates operationId: ListAddons parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: List pagination size, default 1000, max value is 1000 explode: true in: query name: limit required: false schema: type: integer style: form - description: List pagination offset, default 0 explode: true in: query name: offset required: false schema: type: integer style: form responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/BillingAddon' type: array description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: internal error security: - APIKeyAuth: [] summary: List Addons tags: - Billing post: description: Create an addon template operationId: CreateAddon parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAndUpdateAddonParams' description: CreateAndUpdateAddonParams required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/BillingAddon' description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: internal error security: - APIKeyAuth: [] summary: Create Addon tags: - Billing x-codegen-request-body-name: data /org/{orgId}/addon/{addonId}: delete: description: Soft delete an addon template operationId: DeleteAddon parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Addon ID explode: false in: path name: addonId required: true schema: type: string style: simple responses: '200': content: application/json: schema: type: string description: Empty string if deletion is successful '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: internal error security: - APIKeyAuth: [] summary: Delete Addon tags: - Billing get: description: Get an addon template operationId: GetAddon parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Addon ID explode: false in: path name: addonId required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/BillingAddon' description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: internal error security: - APIKeyAuth: [] summary: Get Addon tags: - Billing patch: description: Update an addon template operationId: UpdateAddon parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Addon ID explode: false in: path name: addonId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAndUpdateAddonParams' description: CreateAndUpdateAddonParams required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/BillingAddon' description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: internal error security: - APIKeyAuth: [] summary: Update Addon tags: - Billing x-codegen-request-body-name: data /org/{orgId}/apiClient: get: description: List all API clients in the given organization. operationId: ListApiClients parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/github_com_sugerio_marketplace-service_pkg_legacy_rds-db_lib.IdentityApiClient' type: array description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: List Api Clients tags: - API /org/{orgId}/apiClient/{apiClientId}: get: description: Get the API client by ID. operationId: GetApiClient parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: API client ID explode: false in: path name: apiClientId required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/github_com_sugerio_marketplace-service_pkg_legacy_rds-db_lib.IdentityApiClient' description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Get Api Client tags: - API /org/{orgId}/batchCreateUsageRecordGroups: post: description: Batch report new usage record groups. operationId: BatchReportUsageRecordGroups parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple requestBody: content: application/json: schema: items: $ref: '#/components/schemas/NewUsageRecordGroup' type: array description: Array of new usage record groups to report required: true responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/MeteringUsageRecordGroup' type: array description: OK '400': content: application/json: schema: type: string description: all the quantity of usage records are zero '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Batch Report UsageRecordGroups tags: - Metering x-codegen-request-body-name: usageRecordGroups /org/{orgId}/batchValidateUsageRecordGroups: post: description: Provide a batch of usage record groups and validate each individual usage record group one by one. operationId: BatchValidateUsageRecordGroups parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple requestBody: content: application/json: schema: items: $ref: '#/components/schemas/NewUsageRecordGroup' type: array description: Array of usage record groups to be validated required: true responses: '200': content: application/json: schema: type: string description: Empty string if validation is successful '400': content: application/json: schema: type: string description: Bad request error description '500': content: application/json: schema: type: string description: validation failed for usage record group security: - APIKeyAuth: [] summary: Batch Validate UsageRecordGroups tags: - Metering x-codegen-request-body-name: data /org/{orgId}/billableMetric: get: description: list billable metrics for the given organization. operationId: ListBillableMetrics parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Status of the billable metric explode: true in: query name: status required: false schema: type: string style: form responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/BillableMetric' type: array description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: List Billable Metrics tags: - Metering post: description: Create a new billable metric for the given organization. operationId: CreateBillableMetric parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/BillableMetric' description: RequestBody required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/BillableMetric' description: OK '400': content: application/json: schema: type: string description: Bad request params '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Create Billable Metric tags: - Metering x-codegen-request-body-name: data /org/{orgId}/billableMetric/{billableMetricId}: get: description: Get the billable metric for the given organization and billable metric ID. operationId: GetBillableMetric parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Billable Metric ID explode: false in: path name: billableMetricId required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/BillableMetric' description: OK '400': content: application/json: schema: type: string description: Bad request error '404': content: application/json: schema: type: string description: billable metric not found '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Get Billable Metric tags: - Metering patch: description: Update the name, description and status of the billable metric for the given organization. operationId: UpdateBillableMetric parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Billable Metric ID explode: false in: path name: billableMetricId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateBillableMetricParams' description: RequestBody required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/BillableMetric' description: OK '400': content: application/json: schema: type: string description: Bad request error '404': content: application/json: schema: type: string description: billable metric not found '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Update Billable Metric tags: - Metering x-codegen-request-body-name: data /org/{orgId}/buyer: get: description: list buyers by the given organization with pagination and optional filters. operationId: ListBuyers parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: filter by partner explode: true in: query name: partner required: false schema: type: string style: form - description: filter by contactId explode: true in: query name: contactId required: false schema: type: string style: form - description: filter by awsAccountId explode: true in: query name: awsAccountId required: false schema: type: string style: form - description: List pagination size, default 1000, max value is 1000 explode: true in: query name: limit required: false schema: type: integer style: form - description: List pagination offset, default 0 explode: true in: query name: offset required: false schema: type: integer style: form responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/IdentityBuyer' type: array description: OK '500': content: {} description: Internal Server Error security: - APIKeyAuth: [] summary: List Buyers tags: - Buyer post: description: create a new buyer for Stripe or Adyen under the given organization. operationId: CreateBuyer parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateBuyerParams' description: CreateBuyerParams required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/IdentityBuyer' description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: internal error security: - APIKeyAuth: [] summary: Create Buyer tags: - Buyer x-codegen-request-body-name: data /org/{orgId}/buyer/{buyerId}: get: description: get buyer by the given organization and buyer id. operationId: GetBuyer parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Buyer ID explode: false in: path name: buyerId required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/IdentityBuyer' description: OK '400': content: application/json: schema: type: string description: Bad request error '404': content: application/json: schema: type: string description: not found '500': content: application/json: schema: type: string description: internal error security: - APIKeyAuth: [] summary: Get Buyer tags: - Buyer patch: description: update buyer by the given organization and buyer id. operationId: UpdateBuyer parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Buyer ID explode: false in: path name: buyerId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateBuyerParams' description: UpdateBuyerParams required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/IdentityBuyer' description: OK '500': content: application/json: schema: type: string description: internal error security: - APIKeyAuth: [] summary: Update Buyer tags: - Buyer x-codegen-request-body-name: data /org/{orgId}/buyer/{buyerId}/paymentTransaction/{paymentTransactionId}/refund: get: description: list refunds of the payment transactions. operationId: ListRefundOfPaymentTransaction parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Buyer ID explode: false in: path name: buyerId required: true schema: type: string style: simple - description: Payment transaction ID explode: false in: path name: paymentTransactionId required: true schema: type: string style: simple responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/BillingPaymentTransaction' type: array description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: List Refunds. tags: - Billing post: description: create refund on the payment transaction, support partial refunds multiple times. operationId: CreateRefund parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Buyer ID explode: false in: path name: buyerId required: true schema: type: string style: simple - description: Payment transaction ID explode: false in: path name: paymentTransactionId required: true schema: type: string style: simple - description: Refund amount explode: true in: query name: amount required: true schema: type: number style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/BillingPaymentTransaction' description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Create Refund. tags: - Billing /org/{orgId}/buyer/{buyerId}/wallet: get: description: list all wallets of a buyer. operationId: ListBuyerWallets parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Buyer ID explode: false in: path name: buyerId required: true schema: type: string style: simple responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/BillingWallet' type: array description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: List Buyer's Wallets tags: - Buyer post: description: create a new credit wallet for the buyer. operationId: CreateCreditWallet parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Buyer ID explode: false in: path name: buyerId required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/BillingWallet' description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Create Credit Wallet tags: - Buyer /org/{orgId}/buyer/{buyerId}/wallet/{walletId}: delete: description: delete a wallet of the buyer, if it's a payment method, sync to payment provider too. operationId: DeleteBuyerWallet parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Buyer ID explode: false in: path name: buyerId required: true schema: type: string style: simple - description: Wallet ID explode: false in: path name: walletId required: true schema: type: string style: simple responses: '200': content: application/json: schema: type: string description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Delete Buyer Wallet tags: - Buyer patch: description: update startTime or expireTime of the wallet. operationId: UpdateCreditWallet parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Buyer ID explode: false in: path name: buyerId required: true schema: type: string style: simple - description: Wallet ID explode: false in: path name: walletId required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/BillingWallet' description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Update Credit Wallet tags: - Buyer /org/{orgId}/buyer/{buyerId}/wallet/{walletId}/close: patch: description: Close the given credit wallet, if it's a payment method, sync to payment provider too. Once closed, it can't be used for payment. operationId: CloseCreditWallet parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Buyer ID explode: false in: path name: buyerId required: true schema: type: string style: simple - description: Wallet ID explode: false in: path name: walletId required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/BillingWallet' description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Close Credit Wallet tags: - Buyer /org/{orgId}/buyer/{buyerId}/wallet/{walletId}/default: patch: description: set a payment method wallet as buyer's default wallet. operationId: SetBuyerDefaultWallet parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Buyer ID explode: false in: path name: buyerId required: true schema: type: string style: simple - description: Wallet ID explode: false in: path name: walletId required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/IdentityBuyer' description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Set Buyer Default Wallet tags: - Buyer /org/{orgId}/contact: get: description: List all contacts under the given organization. operationId: ListContactsByOrganization parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: List pagination size, default 1000, max value is 1000 explode: true in: query name: limit required: false schema: type: integer style: form - description: List pagination offset, default 0 explode: true in: query name: offset required: false schema: type: integer style: form responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/IdentityContact' type: array description: OK '400': content: application/json: schema: type: string description: Bad request error description '500': content: application/json: schema: type: string description: internal error description security: - APIKeyAuth: [] summary: List Contacts By Organization tags: - Contact post: description: Create a contact under the given organization. If the email address already exists, return the existing contact. operationId: CreateContact parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/IdentityContact' description: RequestBody required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/IdentityContact' description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Create Contact tags: - Contact x-codegen-request-body-name: data /org/{orgId}/contact/{contactId}: get: description: Get the Contact by the given contact ID. operationId: GetContact parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Contact ID explode: false in: path name: contactId required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/IdentityContact' description: the Contact Object '400': content: application/json: schema: type: string description: Bad request error description '500': content: application/json: schema: type: string description: internal error description security: - APIKeyAuth: [] summary: Get Contact tags: - Contact patch: description: update contact by the given organization and buyer id. The given name and information should be complete. Please note that this function does not support partial updates. operationId: UpdateContact parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Contact ID explode: false in: path name: contactId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/IdentityContact' description: Request Body required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/IdentityContact' description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Update Contact tags: - Contact x-codegen-request-body-name: data /org/{orgId}/contact/{contactId}/buyer/{buyerId}: delete: description: remove contact from buyer by the given organization, buyer id and contact id. operationId: RemoveContactFromBuyer parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Buyer ID explode: false in: path name: buyerId required: true schema: type: string style: simple - description: Contact ID explode: false in: path name: contactId required: true schema: type: string style: simple responses: '200': content: application/json: schema: type: string description: empty string if success '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Remove Contact From Buyer tags: - Contact post: description: add contact to buyer by the given organization, buyer id and contact id. operationId: AddContactToBuyer parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Buyer ID explode: false in: path name: buyerId required: true schema: type: string style: simple - description: Contact ID explode: false in: path name: contactId required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/IdentityBuyer' description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Add Contact To Buyer tags: - Contact /org/{orgId}/contact/{contactId}/offer/{offerId}: delete: description: remove contact from offer by given organization, offer id and contact id. operationId: RemoveContactFromOffer parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Contact ID explode: false in: path name: contactId required: true schema: type: string style: simple - description: Offer ID explode: false in: path name: offerId required: true schema: type: string style: simple responses: '200': content: application/json: schema: type: string description: empty string if success '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Remove Contact From Offer tags: - Contact post: description: add contact to offer by the given organization, offer id and contact id. operationId: AddContactToOffer parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Contact ID explode: false in: path name: contactId required: true schema: type: string style: simple - description: Offer ID explode: false in: path name: offerId required: true schema: type: string style: simple responses: '200': content: application/json: schema: type: string description: empty string if success '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Add Contact To Offer tags: - Contact /org/{orgId}/contact/batch: post: description: Create multiple contacts under the given organization. If an email address already exists, return the existing contact. operationId: BatchCreateContacts parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple requestBody: content: application/json: schema: items: $ref: '#/components/schemas/IdentityContact' type: array description: RequestBody required: true responses: '200': content: application/json: schema: items: items: $ref: '#/components/schemas/IdentityContact' type: array type: array description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Batch Create Contacts tags: - Contact x-codegen-request-body-name: data /org/{orgId}/dailyRevenueRecord: get: description: list daily revenue records for the given organization, partner, entitlement, or buyer, within the given date range. operationId: ListDailyRevenueRecords parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Cloud Partner explode: true in: query name: partner required: false schema: enum: - AWS - AZURE - GCP type: string style: form - description: Filter daily revenue records by the given product ID explode: true in: query name: productId required: false schema: type: string style: form - description: Filter daily revenue records by the given buyer ID explode: true in: query name: buyerId required: false schema: type: string style: form - description: Filter daily revenue records by the given entitlement ID explode: true in: query name: entitlementId required: false schema: type: string style: form - description: start date (UTC) in YYYY-MM-DD format, default is 30 days before the endDate explode: true in: query name: startDate required: false schema: type: string style: form - description: end date (UTC) in YYYY-MM-DD format, default is today explode: true in: query name: endDate required: false schema: type: string style: form responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/RevenueRecord' type: array description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: List Daily Revenue Records tags: - Report /org/{orgId}/draftOffer: post: description: Create a new draft offer or update the existing draft offer. When updating draft offer, the offer.ID is required. operationId: CreateOrUpdateDraftOffer parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkloadOffer' description: the draft offer to create required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/WorkloadOffer' description: OK '400': content: application/json: schema: type: string description: Bad request error '405': content: application/json: schema: type: string description: Method not allowed '500': content: application/json: schema: type: string description: Internal error security: - APIKeyAuth: [] summary: Create Or Update Draft Offer tags: - Offer x-codegen-request-body-name: data /org/{orgId}/draftProduct: post: description: Create a new draft product or update the existing draft product. When updating draft product, the product.ID is required. operationId: CreateOrUpdateDraftProduct parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkloadProduct' description: the draft product to create required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/WorkloadProduct' description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Create Or Update Draft Product tags: - Product x-codegen-request-body-name: data /org/{orgId}/entitlement: get: description: List entitlements under the given organization with pagination and optional filters. operationId: ListEntitlements parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: filter by partner explode: true in: query name: partner required: false schema: type: string style: form - description: filter by productId explode: true in: query name: productId required: false schema: type: string style: form - description: filter by offerId explode: true in: query name: offerId required: false schema: type: string style: form - description: filter by buyerId explode: true in: query name: buyerId required: false schema: type: string style: form - description: filter by externalId explode: true in: query name: externalId required: false schema: type: string style: form - description: filter by buyerAccountId is currently supported only for AWS explode: true in: query name: buyerAccountId required: false schema: type: string style: form - description: List pagination size, default 1000, max value is 1000 explode: true in: query name: limit required: false schema: type: integer style: form - description: List pagination offset, default 0 explode: true in: query name: offset required: false schema: type: integer style: form responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/WorkloadEntitlement' type: array description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: List Entitlements tags: - Entitlement post: description: Create an new entitlement for the given buyer & offer. Only applicable to non cloud billing partners. operationId: CreateEntitlement parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateEntitlementParams' description: RequestBody required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/WorkloadEntitlement' description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Create Entitlement tags: - Entitlement x-codegen-request-body-name: data /org/{orgId}/entitlement/{entitlementId}: get: description: Get the entitlement by ID. operationId: GetEntitlement parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Entitlement ID explode: false in: path name: entitlementId required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/WorkloadEntitlement' description: OK '400': content: application/json: schema: type: string description: Bad request error '404': content: application/json: schema: type: string description: Not found '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Get Entitlement tags: - Entitlement /org/{orgId}/entitlement/{entitlementId}/addCredit: post: description: Add the credit amount to the given Entitlement. The credit amount is accumulated & saved in the current Entitlement Term of the gvien Entitlement. operationId: AddEntitlementCredit parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Entitlement ID explode: false in: path name: entitlementId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/AddEntitlementCreditParams' description: RequestBody required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AddEntitlementCreditResponse' description: OK '400': content: application/json: schema: type: string description: Bad Request Error '500': content: application/json: schema: type: string description: Internal Server Error security: - APIKeyAuth: [] summary: Add Entitlement Credit tags: - Entitlement x-codegen-request-body-name: data /org/{orgId}/entitlement/{entitlementId}/addon: post: description: Apply one billing addon to the given Entitlement. The entitlement status must be ACTIVE. operationId: ApplyAddonToEntitlement parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Entitlement ID explode: false in: path name: entitlementId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/BillingAddonRecord' description: RequestBody required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/WorkloadEntitlement' description: Entitlement '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Apply Addon To Entitlement tags: - Entitlement x-codegen-request-body-name: data /org/{orgId}/entitlement/{entitlementId}/approve: post: description: Approve the given Entitlement. Only applicable to the Azure or GCP Entitlements with the status of "PENDING_START". Return 200 if the entitlement is already active. operationId: ApproveEntitlement parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Entitlement ID explode: false in: path name: entitlementId required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/WorkloadEntitlement' description: OK '400': content: application/json: schema: type: string description: Bad request error '404': content: application/json: schema: type: string description: Not found '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Approve Entitlement tags: - Entitlement /org/{orgId}/entitlement/{entitlementId}/cancel: post: description: Cancel the active subscription in Azure Marketplace. operationId: CancelEntitlement parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Entitlement ID explode: false in: path name: entitlementId required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/WorkloadEntitlement' description: the canceled Entitlement '400': content: application/json: schema: type: string description: Bad request error '404': content: application/json: schema: type: string description: Not found '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Cancel Entitlement tags: - Entitlement /org/{orgId}/entitlement/{entitlementId}/divideCommit: post: description: Divide the commit equally from the given entitlement into sub entitlement terms based on the given time periods. operationId: DivideEntitlementCommit parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Entitlement ID explode: false in: path name: entitlementId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/DivideEntitlementCommitParams' description: RequestBody required: true responses: '200': content: application/json: schema: type: string description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Divide Entitlement Commit tags: - Entitlement x-codegen-request-body-name: data /org/{orgId}/entitlement/{entitlementId}/entitlementName: patch: description: Update the name of the given Entitlement. operationId: UpdateEntitlementName parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Entitlement ID explode: false in: path name: entitlementId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/github_com_sugerio_marketplace-service_pkg_legacy_rds-db_lib.UpdateEntitlementNameParams' description: UpdateEntitlementNameParams required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/WorkloadEntitlement' description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Update Entitlement Name tags: - Entitlement x-codegen-request-body-name: data /org/{orgId}/entitlement/{entitlementId}/entitlementTerm: get: description: List all Entitlement Terms of the given Entitlement. operationId: ListEntitlementTerms parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Entitlement ID explode: false in: path name: entitlementId required: true schema: type: string style: simple responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/WorkloadEntitlementTerm' type: array description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: List Entitlement Terms tags: - Entitlement /org/{orgId}/entitlement/{entitlementId}/entitlementTerm/{entitlementTermId}: delete: description: Delete the entitlement term by the given entitlement ID and entitlement term ID. Only allow to delete the divided entitlement term. operationId: DeleteEntitlementTerm parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Entitlement ID explode: false in: path name: entitlementId required: true schema: type: string style: simple - description: Entitlement Term ID explode: false in: path name: entitlementTermId required: true schema: type: string style: simple responses: '200': content: application/json: schema: type: string description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Delete Entitlement Term tags: - Entitlement get: description: Get the entitlement term by ID. operationId: GetEntitlementTerm parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Entitlement ID explode: false in: path name: entitlementId required: true schema: type: string style: simple - description: Entitlement Term ID explode: false in: path name: entitlementTermId required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/WorkloadEntitlementTerm' description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Get Entitlement Term tags: - Entitlement /org/{orgId}/entitlement/{entitlementId}/metaInfo: patch: description: Update the meta info of the given entitlement. operationId: UpdateEntitlementMetaInfo parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Entitlement ID explode: false in: path name: entitlementId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkloadMetaInfo' description: Entitlement meta info to update required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/WorkloadMetaInfo' description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: internal server error security: - APIKeyAuth: [] summary: Update Entitlement Meta Info tags: - Entitlement x-codegen-request-body-name: data /org/{orgId}/entitlement/{entitlementId}/priceModel: patch: description: Update the price model of the given entitlement, such as recurring commits, billable dimensions. Only applicable to non cloud billing partners. operationId: UpdateEntitlementPriceModel parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Entitlement ID explode: false in: path name: entitlementId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateEntitlementPriceModelParams' description: Entitlement price model update params required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/WorkloadEntitlement' description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: internal server error security: - APIKeyAuth: [] summary: Update Entitlement Price Model tags: - Entitlement x-codegen-request-body-name: data /org/{orgId}/entitlement/{entitlementId}/scheduleCancellation: post: description: Schedule the cancellation of the given Entitlement. operationId: ScheduleEntitlementCancellation parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Entitlement ID explode: false in: path name: entitlementId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CancellationSchedule' description: RequestBody required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/WorkloadEntitlement' description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Schedule Entitlement Cancellation tags: - Entitlement x-codegen-request-body-name: data /org/{orgId}/entitlement/{entitlementId}/seat: patch: description: Update the seat number for the active AZURE subscription. operationId: UpdateEntitlementSeat parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Entitlement ID explode: false in: path name: entitlementId required: true schema: type: string style: simple - description: New seat number explode: true in: query name: newSeat required: true schema: type: integer style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/WorkloadEntitlement' description: the original entitlement before the seat update '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Update Seat For The Active AZURE Subscription tags: - Entitlement /org/{orgId}/entitlement/{entitlementId}/unscheduleCancellation: post: description: Unschedule the cancellation of the given Entitlement. operationId: UnscheduleEntitlementCancellation parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Entitlement ID explode: false in: path name: entitlementId required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/WorkloadEntitlement' description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Unschedule Entitlement Cancellation tags: - Entitlement /org/{orgId}/entitlement/{entitlementId}/usageRecordGroup: post: description: It is recommended to provide the ID in the request body CreateUsageRecordGroupParams, so the report can be deduplicated. All duplicate report will return error code 409. operationId: ReportUsageRecordGroup parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Entitlement ID explode: false in: path name: entitlementId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateUsageRecordGroupParams' description: RequestBody required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/MeteringUsageRecordGroup' description: OK '400': content: application/json: schema: type: string description: all the quantity of usage records are zero '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Report UsageRecordGroup tags: - Metering x-codegen-request-body-name: data /org/{orgId}/invoice: get: description: List invoices with pagination and filter by status (optional) operationId: ListInvoices parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Optional, filter by the entitlement ID explode: true in: query name: entitlementId required: false schema: type: string style: form - description: Optional, filter by the given buyer ID explode: true in: query name: buyerId required: false schema: type: string style: form - description: Optional, filter by invoice status as filter, if not provided, all status invoices are returned explode: true in: query name: status required: false schema: enum: - DRAFT - FINALIZED - CANCELED - DELETED - '' type: string style: form - description: List pagination size, default 1000, max value is 1000 explode: true in: query name: limit required: false schema: type: integer style: form - description: List pagination offset, default 0 explode: true in: query name: offset required: false schema: type: integer style: form responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/BillingInvoice' type: array description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal error security: - APIKeyAuth: [] summary: List Invoices tags: - Billing /org/{orgId}/invoice/{invoiceId}: get: description: Get the invoice by ID operationId: GetInvoice parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Invoice ID explode: false in: path name: invoiceId required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/BillingInvoice' description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Get Invoice tags: - Billing /org/{orgId}/invoice/{invoiceId}/info: patch: description: Update a draft invoice. Only DueDate, OverallDiscount, and Memo can be updated. operationId: UpdateInvoiceInfo parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Invoice ID explode: false in: path name: invoiceId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateInvoiceInfoRequest' description: Update Invoice Info Request Params required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/BillingInvoiceInfo' description: Updated Invoice info '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Update Invoice Info tags: - Billing x-codegen-request-body-name: data /org/{orgId}/invoice/{invoiceId}/issue: patch: description: Issue the invoice immediately. It can be used for manual issue or reissue invoice. operationId: IssueInvoice parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Invoice ID explode: false in: path name: invoiceId required: true schema: type: string style: simple requestBody: content: application/json: schema: items: type: string type: array description: List of Contact IDs required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/BillingInvoice' description: the issued Invoice '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Issue Invoice tags: - Billing x-codegen-request-body-name: contactIds /org/{orgId}/invoice/{invoiceId}/pay: patch: description: Initiate the payment for the invoice immediately. It can be used for manual payment or retry payment. operationId: PayInvoice parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Invoice ID explode: false in: path name: invoiceId required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/BillingInvoice' description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Pay Invoice tags: - Billing /org/{orgId}/invoice/{invoiceId}/preview: get: description: Returns the preview HTML content of the invoice issued email. operationId: PreviewInvoiceEmail parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Invoice ID explode: false in: path name: invoiceId required: true schema: type: string style: simple responses: '200': content: text/html: schema: type: string description: HTML content of the invoice issued email '400': content: text/html: schema: type: string description: Bad request error '500': content: text/html: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Preview Invoice Email tags: - Billing /org/{orgId}/invoice/{invoiceId}/void: patch: description: Void the invoice. It can be used for manual void or cancel the invoice. operationId: VoidInvoice parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Invoice ID explode: false in: path name: invoiceId required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/BillingInvoice' description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Void Invoice tags: - Billing /org/{orgId}/notificationEvent: get: description: List the notification events of the given organization with pagination and optional filters. operationId: ListNotificationEvents parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: start date (UTC) in YYYY-MM-DD format, default is 30 days before the endDate explode: true in: query name: startDate required: false schema: type: string style: form - description: end date (UTC) in YYYY-MM-DD format, default is today explode: true in: query name: endDate required: false schema: type: string style: form - description: List pagination size, default 1000, max value is 1000 explode: true in: query name: limit required: false schema: type: integer style: form - description: List pagination offset, default 0 explode: true in: query name: offset required: false schema: type: integer style: form - description: 'Filter by priorities, empty means HIGH and CRITICAL only. Valid values are: LOW, MEDIUM, HIGH, CRITICAL. Multiple values are supported, separated by comma.' explode: true in: query name: priorities required: false schema: type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListNotificationEventsResponse' description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: List Notification Events tags: - Notification /org/{orgId}/notificationEvent/{entityType}/{entityId}: get: description: List the notification events of the given organization and entity with pagination. operationId: ListNotificationEventsByEntity parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: 'Entity type, valid values are: PRODUCT, OFFER, ENTITLEMENT, INTEGRATION etc.' explode: false in: path name: entityType required: true schema: type: string style: simple - description: Entity ID explode: false in: path name: entityId required: true schema: type: string style: simple - description: List pagination size, default 1000, max value is 1000 explode: true in: query name: limit required: false schema: type: integer style: form - description: List pagination offset, default 0 explode: true in: query name: offset required: false schema: type: integer style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListNotificationEventsResponse' description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: List Notification Events By Entity tags: - Notification /org/{orgId}/notificationMessage: get: description: List the notification messages of the given organization with pagination. operationId: ListNotificationMessages parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: List pagination size, default 1000, max value is 1000 explode: true in: query name: limit required: false schema: type: integer style: form - description: List pagination offset, default 0 explode: true in: query name: offset required: false schema: type: integer style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListNotificationMessagesResponse' description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: List Notification Messages tags: - Notification /org/{orgId}/notificationMessage/{notificationMessageId}: get: description: Get the notification message of the organization & notification message ID. operationId: GetNotificationMessage parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Notification Message ID explode: false in: path name: notificationMessageId required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/NotificationMessage' description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Get Notification Message tags: - Notification /org/{orgId}/offer: get: description: List offers under the given organization with pagination and optional filter. operationId: ListOffers parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: filter by offer status explode: true in: query name: status required: false schema: type: string style: form - description: filter by partner explode: true in: query name: partner required: false schema: type: string style: form - description: filter by offerType explode: true in: query name: offerType required: false schema: type: string style: form - description: filter by productId explode: true in: query name: productId required: false schema: type: string style: form - description: filter by buyerId explode: true in: query name: buyerId required: false schema: type: string style: form - description: filter by hubspotDealId explode: true in: query name: hubspotDealId required: false schema: type: string style: form - description: filter by contactId explode: true in: query name: contactId required: false schema: type: string style: form - description: List pagination size, default 1000, max value is 1000 explode: true in: query name: limit required: false schema: type: integer style: form - description: List pagination offset, default 0 explode: true in: query name: offset required: false schema: type: integer style: form responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/WorkloadOffer' type: array description: OK '400': content: application/json: schema: type: string description: Bad request error '405': content: application/json: schema: type: string description: Method not allowed '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: List Offers tags: - Offer post: description: Create a private offer under the given organization. operationId: CreateOffer parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkloadOffer' description: Offer to create required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/WorkloadOffer' description: OK '400': content: application/json: schema: type: string description: Bad request error '405': content: application/json: schema: type: string description: Method not allowed '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Create Offer tags: - Offer x-codegen-request-body-name: data /org/{orgId}/offer/{offerId}: delete: description: The offer is soft deleted (marked as DELETED status) in Suger service. Only the offer with status = "DRAFT", "CREATE_FAILED", "EXPIRED" or "CANCELLED" is allowed to be deleted. operationId: DeleteOffer parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Offer ID explode: false in: path name: offerId required: true schema: type: string style: simple responses: '200': content: application/json: schema: type: string description: Empty string if deletion is successful '400': content: application/json: schema: type: string description: Bad request error '404': content: application/json: schema: type: string description: Not found error '500': content: application/json: schema: type: string description: Internal error security: - APIKeyAuth: [] summary: Delete Offer tags: - Offer get: description: Get the offer by the given offer ID. operationId: GetOffer parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Offer ID explode: false in: path name: offerId required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/WorkloadOffer' description: the Offer Object '400': content: application/json: schema: type: string description: Bad request error '404': content: application/json: schema: type: string description: Not found '405': content: application/json: schema: type: string description: Method not allowed '500': content: application/json: schema: type: string description: Internal error security: - APIKeyAuth: [] summary: Get Offer tags: - Offer /org/{orgId}/offer/{offerId}/cancel: post: description: Only the offer with status = "PENDING_ACCEPTANCE", "PENDING_CANCEL", "ACTIVE" or "USED" is allowed to cancel. operationId: CancelOffer parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Offer ID explode: false in: path name: offerId required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/WorkloadOffer' description: OK '400': content: application/json: schema: type: string description: Bad request error '405': content: application/json: schema: type: string description: Method not allowed '500': content: application/json: schema: type: string description: Internal error security: - APIKeyAuth: [] summary: Cancel Offer tags: - Offer /org/{orgId}/offer/{offerId}/eula: get: description: Get the EULA file of the given offer ID. operationId: GetOfferEula parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Offer ID explode: false in: path name: offerId required: true schema: type: string style: simple - description: response format in JSON or string explode: true in: query name: format required: false schema: type: string style: form responses: '200': content: application/json: schema: type: string description: AWS S3 signed URL with 30 minutes expiry time '400': content: application/json: schema: type: string description: Bad request error '405': content: application/json: schema: type: string description: Method not allowed '500': content: application/json: schema: type: string description: Internal error security: - APIKeyAuth: [] summary: Get Offer EULA tags: - Offer /org/{orgId}/offer/{offerId}/extendExpiryDate: post: description: Only the offer with status = "PENDING_ACCEPTANCE", "EXPIRED" or "ACCEPTED" is allowed to extend expiry date. operationId: ExtendPrivateOfferExpiryDate parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Offer ID explode: false in: path name: offerId required: true schema: type: string style: simple - description: new expiry date in YYYY-MM-DD format explode: true in: query name: newExpiryDate required: true schema: type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/WorkloadOffer' description: OK '400': content: application/json: schema: type: string description: Bad request error '404': content: application/json: schema: type: string description: Not found '500': content: application/json: schema: type: string description: Internal error security: - APIKeyAuth: [] summary: Extend Offer Expiry Date tags: - Offer /org/{orgId}/offer/{offerId}/metaInfo: patch: description: Update the meta info of the given offer. operationId: UpdateOfferMetaInfo parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Offer ID explode: false in: path name: offerId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkloadMetaInfo' description: Offer meta info to update required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/WorkloadMetaInfo' description: OK '400': content: application/json: schema: type: string description: Bad request error '405': content: application/json: schema: type: string description: Method not allowed '500': content: application/json: schema: type: string description: Internal error security: - APIKeyAuth: [] summary: Update Offer Meta Info tags: - Offer x-codegen-request-body-name: data /org/{orgId}/offer/{offerId}/notifyContacts: post: description: Send offer notifications to the given contact ids. If contactIDs is empty, send notifications to all contacts of the offer. operationId: SendOfferNotifications parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Offer ID explode: false in: path name: offerId required: true schema: type: string style: simple requestBody: content: application/json: schema: items: type: string type: array description: List of Contact IDs, if emoty or nil, send notifications to all contacts of the offer required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/NotificationEvent' description: NotificationEvent object '400': content: application/json: schema: type: string description: Bad request error '405': content: application/json: schema: type: string description: Method not allowed '500': content: application/json: schema: type: string description: Internal error security: - APIKeyAuth: [] summary: Notify Offer Contacts tags: - Offer x-codegen-request-body-name: contactIDs /org/{orgId}/offer/{offerId}/resellerEula: get: description: Get the Reseller EULA file of the given offer ID. operationId: GetOfferResellerEula parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Offer ID explode: false in: path name: offerId required: true schema: type: string style: simple responses: '200': content: application/json: schema: type: string description: AWS S3 signed URL with 30 minutes expiry time '400': content: application/json: schema: type: string description: Bad request error '405': content: application/json: schema: type: string description: Method not allowed '500': content: application/json: schema: type: string description: Internal error security: - APIKeyAuth: [] summary: Get Offer Reseller EULA tags: - Offer /org/{orgId}/offerExternalId/{offerExternalId}: get: description: Get the offer by the given offer external ID. operationId: GetOfferByExternalId parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Offer External ID explode: false in: path name: offerExternalId required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/WorkloadOffer' description: the Offer Object '400': content: application/json: schema: type: string description: Bad request error '404': content: application/json: schema: type: string description: Not found '405': content: application/json: schema: type: string description: Method not allowed '500': content: application/json: schema: type: string description: Internal error security: - APIKeyAuth: [] summary: Get Offer By External ID tags: - Offer /org/{orgId}/partner/{partner}/product: get: description: list all products under the given organization and cloud partner operationId: ListProductsByPartner parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Cloud Partner explode: false in: path name: partner required: true schema: enum: - AWS - AZURE - GCP type: string style: simple responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/WorkloadProduct' type: array description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: List Products By Partner tags: - Product /org/{orgId}/partner/{partner}/revenueRecord: get: description: list the revenue records for the given organization, product, entitlement, or buyer. operationId: ListRevenueRecords parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Cloud Partner explode: false in: path name: partner required: true schema: enum: - AWS - AZURE - GCP type: string style: simple - description: Filter revenue records by the given product ID explode: true in: query name: productId required: false schema: type: string style: form - description: Filter revenue records by the given entitlement ID explode: true in: query name: entitlementId required: false schema: type: string style: form - description: Filter revenue records by the given buyer ID explode: true in: query name: buyerId required: false schema: type: string style: form - description: start date (UTC) in YYYY-MM-DD format, default is 30 days before the endDate explode: true in: query name: startDate required: false schema: type: string style: form - description: end date (UTC) in YYYY-MM-DD format, default is today explode: true in: query name: endDate required: false schema: type: string style: form - description: List pagination size, default 1000, max value is 1000 explode: true in: query name: limit required: false schema: type: integer style: form - description: List pagination offset, default 0 explode: true in: query name: offset required: false schema: type: integer style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListRevenueRecordsResponse' description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: List Revenue Records tags: - Report /org/{orgId}/partner/{partner}/revenueRecordDetail: get: description: list the raw revenue record details for the given organization, partner, product, entitlement, or buyer. operationId: ListRevenueRecordDetails parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Cloud Partner explode: false in: path name: partner required: true schema: enum: - AWS - AZURE - GCP type: string style: simple - description: Filter revenue record details by the given product ID explode: true in: query name: productId required: false schema: type: string style: form - description: Filter revenue record details by the given buyer ID explode: true in: query name: buyerId required: false schema: type: string style: form - description: Filter revenue record details by the given entitlement ID explode: true in: query name: entitlementId required: false schema: type: string style: form - description: start date (UTC) in YYYY-MM-DD format, default is 30 days before the endDate explode: true in: query name: startDate required: false schema: type: string style: form - description: end date (UTC) in YYYY-MM-DD format, default is today explode: true in: query name: endDate required: false schema: type: string style: form - description: List pagination size, default 1000, max value is 1000 explode: true in: query name: limit required: false schema: type: integer style: form - description: List pagination offset, default 0 explode: true in: query name: offset required: false schema: type: integer style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListRevenueRecordDetailsResponse' description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: List Revenue Record Details tags: - Report /org/{orgId}/partner/{partner}/usageMeteringDailyRecord: get: description: list the daily records of the usage metering from the cloud marketplace for the given organization, entitlement, or buyer. operationId: ListUsageMeteringDailyRecords parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Filter by the Cloud Partner explode: false in: path name: partner required: true schema: enum: - AWS - AZURE - GCP type: string style: simple - description: Filter usage metering daily records by the given buyer ID explode: true in: query name: buyerId required: false schema: type: string style: form - description: Filter usage metering daily records by the given entitlement ID explode: true in: query name: entitlementId required: false schema: type: string style: form - description: start date (UTC) in YYYY-MM-DD format, default is 30 days before the endDate explode: true in: query name: startDate required: false schema: type: string style: form - description: end date (UTC) in YYYY-MM-DD format, default is today explode: true in: query name: endDate required: false schema: type: string style: form - description: List pagination size, default 1000, max value is 1000 explode: true in: query name: limit required: false schema: type: integer style: form - description: List pagination offset, default 0 explode: true in: query name: offset required: false schema: type: integer style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListUsageMeteringDailyRecordsResponse' description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: List Usage Metering Daily Records tags: - Report /org/{orgId}/paymentTransaction: get: description: List payment transactions with pagination and filters operationId: ListPaymentTransactions parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Optional, filter by the given buyer ID explode: true in: query name: buyerId required: false schema: type: string style: form - description: Optional, filter by the given entitlement ID explode: true in: query name: entitlementId required: false schema: type: string style: form - description: Optional, filter by the given invoice ID explode: true in: query name: invoiceId required: false schema: type: string style: form - description: Optional, filter by status explode: true in: query name: status required: false schema: enum: - PENDING - PROCESSING - SUCCESS - FAILED type: string style: form - description: Optional, filter by transaction type explode: true in: query name: type required: false schema: enum: - CHARGE - REFUND type: string style: form - description: List pagination size, default 1000, max value is 1000 explode: true in: query name: limit required: false schema: type: integer style: form - description: List pagination offset, default 0 explode: true in: query name: offset required: false schema: type: integer style: form responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/BillingPaymentTransaction' type: array description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: List Payment Transactions tags: - Billing /org/{orgId}/product: get: description: list all products under the given organization operationId: ListProducts parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: filter by partner explode: true in: query name: partner required: false schema: enum: - AWS - AZURE - GCP - STRIPE type: string style: form - description: List pagination size, default 100, max value is 1000 explode: true in: query name: limit required: false schema: type: integer style: form - description: List pagination offset, default 0 explode: true in: query name: offset required: false schema: type: integer style: form responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/WorkloadProduct' type: array description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: List Products tags: - Product post: description: create a new product in the marketplace operationId: CreateProduct parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkloadProduct' description: the product to create required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/WorkloadProduct' description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Create Product tags: - Product x-codegen-request-body-name: data /org/{orgId}/product/{productId}: delete: description: The product is soft deleted (marked as DELETED status) in Suger service. only the products with non PUBLIC status are allowed to be deleted. operationId: DeleteProduct parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Product ID explode: false in: path name: productId required: true schema: type: string style: simple responses: '200': content: application/json: schema: type: string description: Empty string if deletion is successful '400': content: application/json: schema: type: string description: Bad request error '404': content: application/json: schema: type: string description: Not found error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Delete Product tags: - Product get: description: get product by product id operationId: GetProduct parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Product ID explode: false in: path name: productId required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/WorkloadProduct' description: OK '400': content: application/json: schema: type: string description: Bad request error '404': content: application/json: schema: type: string description: Not found error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Get Product tags: - Product patch: description: update product info, no price update is allowed via this API. operationId: UpdateProduct parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Product ID explode: false in: path name: productId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkloadProduct' description: the product to update required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/WorkloadProduct' description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Update Product tags: - Product x-codegen-request-body-name: data /org/{orgId}/product/{productId}/dimension: get: description: list all metering dimensions of the given product operationId: ListProductMeteringDimensions parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Product ID explode: false in: path name: productId required: true schema: type: string style: simple responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/MeteringDimension' type: array description: OK '400': content: application/json: schema: type: string description: Bad request error '404': content: application/json: schema: type: string description: Not found error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: List Metering Dimensions Of Product tags: - Product /org/{orgId}/product/{productId}/fulfillmentUrl: patch: description: update the fulfillment url of the given product operationId: UpdateProductFulfillmentUrl parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Product ID explode: false in: path name: productId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateProductParams' description: Update Product Params required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/WorkloadProduct' description: OK '500': content: {} description: Internal Server Error security: - APIKeyAuth: [] summary: Update Product Fulfillment Url tags: - Product x-codegen-request-body-name: data /org/{orgId}/product/{productId}/metaInfo: patch: description: Update the meta info of the given product. operationId: UpdateProductMetaInfo parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Product ID explode: false in: path name: productId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkloadMetaInfo' description: Product meta info to update required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/WorkloadMetaInfo' description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: internal server error security: - APIKeyAuth: [] summary: Update Product Meta Info tags: - Product x-codegen-request-body-name: data /org/{orgId}/product/{productId}/publish: patch: description: publish the given product to the public status in the marketplace operationId: PublishProduct parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Product ID explode: false in: path name: productId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkloadProduct' description: the product to publish required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/WorkloadProduct' description: OK '400': content: application/json: schema: type: string description: Bad request error '404': content: application/json: schema: type: string description: Not found error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Publish Product tags: - Product x-codegen-request-body-name: data /org/{orgId}/revenueReport: post: description: Get the revenue report of the given organization, product, entitlement, or buyer. operationId: GetRevenueReport parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/GetRevenueReportParams' description: Get Revenue Report Params required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/RevenueReport' description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Get Revenue Report tags: - Report x-codegen-request-body-name: data /org/{orgId}/support/ticket: get: description: list support tickets operationId: ListSupportTickets parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: List pagination size, default 1000, max value is 1000 explode: true in: query name: limit required: false schema: type: integer style: form - description: List pagination offset, default 0 explode: true in: query name: offset required: false schema: type: integer style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListSupportTicketsResponse' description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: List Support Tickets tags: - Support post: description: create support ticket operationId: CreateSupportTicket parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/SupportTicket' description: Ticket create request required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/SupportTicket' description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Create Support Ticket tags: - Support x-codegen-request-body-name: body /org/{orgId}/support/ticket/{ticketId}: get: description: get support ticket operationId: GetSupportTicket parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Ticket ID explode: false in: path name: ticketId required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/SupportTicket' description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Get Support Ticket tags: - Support patch: description: update support ticket operationId: UpdateSupportTicket parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Ticket ID explode: false in: path name: ticketId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateSupportTicketRequest' description: Ticket create request required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/SupportTicket' description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Update Support Ticket tags: - Support x-codegen-request-body-name: body /org/{orgId}/support/ticket/{ticketId}/attachment: post: description: create support ticket attachment operationId: CreateSupportTicketAttachment parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Ticket ID explode: false in: path name: ticketId required: true schema: type: string style: simple requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/CreateSupportTicketAttachment_request' required: true responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/SupportTicketAttachment' type: array description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Create Support Ticket Attachment tags: - Support /org/{orgId}/support/ticket/{ticketId}/close: patch: description: close suuport ticket operationId: CloseSupportTicket parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Ticket ID explode: false in: path name: ticketId required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/SupportTicket' description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Close Support Ticket tags: - Support /org/{orgId}/support/ticket/{ticketId}/comment: post: description: create support ticket comment operationId: CreateSupportTicketComment parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Ticket ID explode: false in: path name: ticketId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/SupportTicketComment' description: Ticket create request required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/SupportTicketComment' description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Create Support Ticket Comment tags: - Support x-codegen-request-body-name: body /org/{orgId}/support/ticket/{ticketId}/reopen: patch: description: reopen support ticket operationId: ReopenSupportTicket parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Ticket ID explode: false in: path name: ticketId required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/SupportTicket' description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Reopen Support Ticket tags: - Support /org/{orgId}/usageMeteringConfigInfo: get: description: Get the usage metering config info of the given organization. operationId: GetUsageMeteringConfigInfo parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple responses: '200': content: application/json: schema: $ref: '#/components/schemas/UsageMeteringConfigInfo' description: Usage metering config info '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Get Usage Metering Config Info tags: - Metering patch: description: Update the usage metering config info of the given organization. operationId: UpdateUsageMeteringConfigInfo parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple requestBody: content: application/json: schema: $ref: '#/components/schemas/UsageMeteringConfigInfo' description: The usage metering config info to be updated required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/UsageMeteringConfigInfo' description: Usage metering config info '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Update Usage Metering Config Info tags: - Metering x-codegen-request-body-name: data /org/{orgId}/usageRecordGroup: get: description: 'List UsageRecordGroups by the given organization, partner, product, entitlement or buyer. Only provide one or none of the optional query parameters: partner, productId, entitlementId & buyerId .' operationId: ListUsageRecordGroups parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Cloud Partner explode: true in: query name: partner required: false schema: enum: - AWS - AZURE - GCP type: string style: form - description: filter by buyer ID, default no filter by buyerId if not provided explode: true in: query name: buyerId required: false schema: type: string style: form - description: filter by entitlement ID, default no filter by entitlementId if not provided explode: true in: query name: entitlementId required: false schema: type: string style: form - description: The status of the usage record group, default no filter by status if not provided explode: true in: query name: status required: false schema: enum: - CREATED - DELETED - INVALID - REPORTED - REPORT_PENDING - REPORT_FAILED type: string style: form - description: The source of the usage record group, default no filter by source if not provided explode: true in: query name: source required: false schema: enum: - '' - API - INTERNAL - LAGO - METRONOME - ORB - STRIPE type: string style: form - description: metaInfo filter explode: true in: query name: metaInfo required: false schema: type: string style: form - description: start date (UTC) in YYYY-MM-DD format, default is 30 days before the endDate explode: true in: query name: startDate required: false schema: type: string style: form - description: end date (UTC) in YYYY-MM-DD format, default is today explode: true in: query name: endDate required: false schema: type: string style: form - description: List pagination size, default 1000, max value is 1000 explode: true in: query name: limit required: false schema: type: integer style: form - description: List pagination offset, default 0 explode: true in: query name: offset required: false schema: type: integer style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListUsageRecordGroupsResponse' description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: List UsageRecordGroups tags: - Metering /org/{orgId}/usageRecordGroup/{usageRecordGroupId}: delete: description: delete the UsageRecordGroup for the given organization and usageRecordGroup ID. Only usageRecordGroup with status "CREATED" or "INVALID" can be deleted. operationId: DeleteUsageRecordGroup parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: UsageRecordGroup ID explode: false in: path name: usageRecordGroupId required: true schema: type: string style: simple - description: UsageRecordGroup's creation date (UTC) in YYYY-MM-DD format explode: true in: query name: creationDate required: false schema: type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/MeteringUsageRecordGroup' description: OK '400': content: application/json: schema: type: string description: Bad request error '404': content: application/json: schema: type: string description: usageRecordGroup not found '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Delete UsageRecordGroup tags: - Metering /org/{orgId}/usageRecordGroup/{usageRecordGroupId}/retry: post: description: Retry the given UsageRecordGroup by setting from status "REPORT_FAILED" to "CREATED", and it will be ready for the next hourly report. Only usageRecordGroup with status "REPORT_FAILED" can be retried. operationId: RetryUsageRecordGroup parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: UsageRecordGroup ID explode: false in: path name: usageRecordGroupId required: true schema: type: string style: simple - description: UsageRecordGroup's creation date (UTC) in YYYY-MM-DD format explode: true in: query name: creationDate required: false schema: type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/MeteringUsageRecordGroup' description: OK '400': content: application/json: schema: type: string description: Bad request error '404': content: application/json: schema: type: string description: usageRecordGroup not found '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: Retry UsageRecordGroup tags: - Metering /org/{orgId}/usageRecordReport: get: description: List usageRecordReports under the given organization, partner, entitlement or buyer, within the given time range and pagination. operationId: ListUsageRecordReports parameters: - description: Organization ID explode: false in: path name: orgId required: true schema: type: string style: simple - description: Cloud Partner explode: true in: query name: partner required: false schema: enum: - AWS - AZURE - GCP type: string style: form - description: buyer ID explode: true in: query name: buyerId required: false schema: type: string style: form - description: entitlement ID explode: true in: query name: entitlementId required: false schema: type: string style: form - description: start date (UTC) in YYYY-MM-DD format, default is 30 days before the endDate explode: true in: query name: startDate required: false schema: type: string style: form - description: end date (UTC) in YYYY-MM-DD format, default is today explode: true in: query name: endDate required: false schema: type: string style: form - description: List pagination size, default 1000, max value is 1000 explode: true in: query name: limit required: false schema: type: integer style: form - description: List pagination offset, default 0 explode: true in: query name: offset required: false schema: type: integer style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListUsageRecordReportsResponse' description: OK '400': content: application/json: schema: type: string description: Bad request error '500': content: application/json: schema: type: string description: Internal server error security: - APIKeyAuth: [] summary: List UsageRecordReports tags: - Metering components: schemas: AddEntitlementCreditParams: example: organizationID: organizationID entitlementTermID: entitlementTermID creditAmountIncrement: 0.8008281904610115 entitlementID: entitlementID properties: creditAmountIncrement: description: The amount to be added to the credit amount. type: number entitlementID: type: string entitlementTermID: description: This is optional. If it is empty, the credit will be added to the default entitlement term of the entitlement. type: string organizationID: type: string required: - creditAmountIncrement - entitlementID - organizationID type: object AddEntitlementCreditResponse: example: organizationID: organizationID entitlementTermID: entitlementTermID creditAmountIncrement: 0.8008281904610115 entitlementID: entitlementID newCreditAmount: 6.027456183070403 properties: creditAmountIncrement: description: The amount to be added to the credit amount. type: number entitlementID: type: string entitlementTermID: type: string newCreditAmount: description: The new credit amount after the increment. type: number organizationID: type: string type: object AdyenBuyer: properties: settings: additionalProperties: true description: Settings store key-value pairs such as paymentMethodId,syncWithProvider,providerPaymentMethods. type: object shopperId: description: The shopperId on the adyen platform corresponding to the buyer. type: string type: object AggregatedMeteringUsageRecord: example: amount: 6.027456183070403 quantity: 1.4658129805029452 name: name billableMetricInfo: groupBys: - groupBys - groupBys propertyUniqueOn: propertyUniqueOn filterGroups: - filters: - valueType: STRING name: name operation: IS value: '{}' - valueType: STRING name: name operation: IS value: '{}' - filters: - valueType: STRING name: name operation: IS value: '{}' - valueType: STRING name: name operation: IS value: '{}' groupBysExpression: groupBysExpression billableMetricAggregationType: COUNT key: key uniqueCountAggregationResult: '{}' properties: amount: description: Amount calculated by billable dimension's price model, this is only used for report billable usage records to marketplace. type: number billableMetricAggregationType: $ref: '#/components/schemas/BillableMetricAggregationType' billableMetricInfo: $ref: '#/components/schemas/BillableMetricInfo' groupBysExpression: description: GroupBysExpression is the string expression of array of group bys. type: string key: description: Key is the unique identifier of a billable metric. type: string name: description: 'Name is the name of a billable metric. Optional, it is only for display purpose.' type: string quantity: description: Value is the value of a billable metric. type: number uniqueCountAggregationResult: allOf: - $ref: '#/components/schemas/UniqueCountAggregationResult' description: Unique count metric aggregate result. type: object type: object AlibabaMarketplaceProduct: example: FrontCategoryId: 6 Status: Status Description: Description RequestId: RequestId ShopInfo: WangWangs: WangWang: - UserName: UserName Remark: Remark - UserName: UserName Remark: Remark Telephones: Telephone: - Telephone - Telephone Emails: Emails Id: 7 Name: Name ProductSkus: ProductSku: - Constraints: Constraints ChargeType: ChargeType Modules: Module: - Id: Id Properties: Property: - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name Code: Code Name: Name - Id: Id Properties: Property: - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name Code: Code Name: Name OrderPeriods: OrderPeriod: - PeriodType: PeriodType Name: Name - PeriodType: PeriodType Name: Name Hidden: true Code: Code Name: Name - Constraints: Constraints ChargeType: ChargeType Modules: Module: - Id: Id Properties: Property: - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name Code: Code Name: Name - Id: Id Properties: Property: - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name Code: Code Name: Name OrderPeriods: OrderPeriod: - PeriodType: PeriodType Name: Name - PeriodType: PeriodType Name: Name Hidden: true Code: Code Name: Name UseCount: 3 GmtModified: 5 GmtCreated: 1 Code: Code Name: Name ShortDescription: ShortDescription SupplierPk: 9 Score: 2.3021358869347655 Type: Type AuditStatus: AuditStatus AuditFailMsg: AuditFailMsg ProductExtras: ProductExtra: - Order: 5 Type: Type Label: Label Values: '{}' Key: Key - Order: 5 Type: Type Label: Label Values: '{}' Key: Key AuditTime: 0 PicUrl: PicUrl properties: AuditFailMsg: type: string AuditStatus: type: string AuditTime: type: integer Code: type: string Description: type: string FrontCategoryId: type: integer GmtCreated: type: integer GmtModified: type: integer Name: type: string PicUrl: type: string ProductExtras: $ref: '#/components/schemas/AlibabaMarketplaceProductExtras' ProductSkus: $ref: '#/components/schemas/AlibabaMarketplaceProductSkus' RequestId: type: string Score: type: number ShopInfo: $ref: '#/components/schemas/AlibabaMarketplaceProductShopInfo' ShortDescription: type: string Status: type: string SupplierPk: type: integer Type: type: string UseCount: type: integer type: object AlibabaMarketplaceProductExtra: example: Order: 5 Type: Type Label: Label Values: '{}' Key: Key properties: Key: type: string Label: type: string Order: type: integer Type: type: string Values: type: object type: object AlibabaMarketplaceProductExtras: example: ProductExtra: - Order: 5 Type: Type Label: Label Values: '{}' Key: Key - Order: 5 Type: Type Label: Label Values: '{}' Key: Key properties: ProductExtra: items: $ref: '#/components/schemas/AlibabaMarketplaceProductExtra' type: array type: object AlibabaMarketplaceProductShopInfo: example: WangWangs: WangWang: - UserName: UserName Remark: Remark - UserName: UserName Remark: Remark Telephones: Telephone: - Telephone - Telephone Emails: Emails Id: 7 Name: Name properties: Emails: type: string Id: type: integer Name: type: string Telephones: $ref: '#/components/schemas/AlibabaMarketplaceProductShopInfoTelephones' WangWangs: $ref: '#/components/schemas/AlibabaMarketplaceProductShopInfoWangWangs' type: object AlibabaMarketplaceProductShopInfoTelephones: example: Telephone: - Telephone - Telephone properties: Telephone: items: type: string type: array type: object AlibabaMarketplaceProductShopInfoWangWang: example: UserName: UserName Remark: Remark properties: Remark: type: string UserName: type: string type: object AlibabaMarketplaceProductShopInfoWangWangs: example: WangWang: - UserName: UserName Remark: Remark - UserName: UserName Remark: Remark properties: WangWang: items: $ref: '#/components/schemas/AlibabaMarketplaceProductShopInfoWangWang' type: array type: object AlibabaMarketplaceProductSku: example: Constraints: Constraints ChargeType: ChargeType Modules: Module: - Id: Id Properties: Property: - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name Code: Code Name: Name - Id: Id Properties: Property: - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name Code: Code Name: Name OrderPeriods: OrderPeriod: - PeriodType: PeriodType Name: Name - PeriodType: PeriodType Name: Name Hidden: true Code: Code Name: Name properties: ChargeType: description: POSTPAY or PREPAY type: string Code: type: string Constraints: type: string Hidden: type: boolean Modules: $ref: '#/components/schemas/AlibabaMarketplaceProductSkuModules' Name: type: string OrderPeriods: $ref: '#/components/schemas/AlibabaMarketplaceProductSkuOrderPeriods' type: object AlibabaMarketplaceProductSkuModule: example: Id: Id Properties: Property: - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name Code: Code Name: Name properties: Code: type: string Id: type: string Name: type: string Properties: $ref: '#/components/schemas/AlibabaMarketplaceProductSkuModuleProperties' type: object AlibabaMarketplaceProductSkuModuleProperties: example: Property: - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name properties: Property: items: $ref: '#/components/schemas/AlibabaMarketplaceProductSkuModuleProperty' type: array type: object AlibabaMarketplaceProductSkuModuleProperty: example: PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name properties: DisplayUnit: type: string Key: type: string Name: type: string PropertyValues: $ref: '#/components/schemas/AlibabaMarketplaceProductSkuModulePropertyValues' showType: type: string type: object AlibabaMarketplaceProductSkuModulePropertyValue: example: Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark properties: DisplayName: type: string Max: type: string Min: type: string Remark: type: string Step: type: string Type: type: string Value: type: string type: object AlibabaMarketplaceProductSkuModulePropertyValues: example: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark properties: PropertyValue: items: $ref: '#/components/schemas/AlibabaMarketplaceProductSkuModulePropertyValue' type: array type: object AlibabaMarketplaceProductSkuModules: example: Module: - Id: Id Properties: Property: - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name Code: Code Name: Name - Id: Id Properties: Property: - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name Code: Code Name: Name properties: Module: items: $ref: '#/components/schemas/AlibabaMarketplaceProductSkuModule' type: array type: object AlibabaMarketplaceProductSkuOrderPeriod: example: PeriodType: PeriodType Name: Name properties: Name: type: string PeriodType: type: string type: object AlibabaMarketplaceProductSkuOrderPeriods: example: OrderPeriod: - PeriodType: PeriodType Name: Name - PeriodType: PeriodType Name: Name properties: OrderPeriod: items: $ref: '#/components/schemas/AlibabaMarketplaceProductSkuOrderPeriod' type: array type: object AlibabaMarketplaceProductSkus: example: ProductSku: - Constraints: Constraints ChargeType: ChargeType Modules: Module: - Id: Id Properties: Property: - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name Code: Code Name: Name - Id: Id Properties: Property: - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name Code: Code Name: Name OrderPeriods: OrderPeriod: - PeriodType: PeriodType Name: Name - PeriodType: PeriodType Name: Name Hidden: true Code: Code Name: Name - Constraints: Constraints ChargeType: ChargeType Modules: Module: - Id: Id Properties: Property: - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name Code: Code Name: Name - Id: Id Properties: Property: - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name Code: Code Name: Name OrderPeriods: OrderPeriod: - PeriodType: PeriodType Name: Name - PeriodType: PeriodType Name: Name Hidden: true Code: Code Name: Name properties: ProductSku: items: $ref: '#/components/schemas/AlibabaMarketplaceProductSku' type: array type: object AuditingEventPriority: enum: - '' - LOW - MEDIUM - HIGH - CRITICAL type: string x-enum-varnames: - AuditingEventPriority_UNKNOWN - AuditingEventPriority_LOW - AuditingEventPriority_MEDIUM - AuditingEventPriority_HIGH - AuditingEventPriority_CRITICAL AwsAccountIdentifier: properties: awsAccountID: description: The AWS Account ID of the buyer in AWS Marketplace type: string awsCustomerID: description: The AWS Customer ID of the buyer in AWS Marketplace type: string dataFeedAccountID: description: The Account ID in AWS Marketplace Data Feed service type: string type: object AwsChannelPartner: properties: id: description: The AWS Account ID of the Channel Partner type: string name: description: The name of the Channel Partner type: string type: object AwsMarketplaceAgreementStatus: enum: - ACTIVE - ARCHIVED - CANCELLED - EXPIRED - RENEWED - REPLACED - ROLLED_BACK - SUPERSEDED - TERMINATED type: string x-enum-varnames: - AwsMarketplaceAgreementStatus_ACTIVE - AwsMarketplaceAgreementStatus_ARCHIVED - AwsMarketplaceAgreementStatus_CANCELLED - AwsMarketplaceAgreementStatus_EXPIRED - AwsMarketplaceAgreementStatus_RENEWED - AwsMarketplaceAgreementStatus_REPLACED - AwsMarketplaceAgreementStatus_ROLLED_BACK - AwsMarketplaceAgreementStatus_SUPERSEDED - AwsMarketplaceAgreementStatus_TERMINATED AwsMarketplaceAgreementV2: properties: acceptanceTime: format: date-time type: string agreementId: description: AWS Marketplace Agreement Id type: string agreementType: type: string buyerAccountId: description: The AWS Account Id of the buyer in AWS Marketplace type: string endTime: format: date-time type: string offerId: description: AWS Marketplace Offer Id type: string productId: description: AWS Marketplace Product Id type: string productType: type: string sellerAccountId: description: The AWS Account Id of the seller in AWS Marketplace type: string startTime: format: date-time type: string status: $ref: '#/components/schemas/AwsMarketplaceAgreementStatus' type: object AwsMarketplaceBuyerAccount: properties: AwsAccountId: type: string type: object AwsMarketplaceCatalogLegalTermDocument: properties: Type: $ref: '#/components/schemas/AwsMarketplaceCatalogLegalTermDocumentType' Url: description: 'A URL to the legal document for buyers to read. Required when Type is one of the following [CustomEula, CustomDsa].' type: string Version: description: 'Version of standard contracts provided by AWS Marketplace. Required when Type is one of the following [StandardEula, StandardDsa]. The version of StandardEula is "2022-07-14". The version of StandardDsa is "2019-12-12".' type: string type: object AwsMarketplaceCatalogLegalTermDocumentType: enum: - CustomEula - CustomDsa - StandardEula - StandardDsa - StandardResellerContract - CustomResellerContract type: string x-enum-varnames: - AwsMarketplaceCatalogLegalTermDocumentType_CustomEula - AwsMarketplaceCatalogLegalTermDocumentType_CustomDsa - AwsMarketplaceCatalogLegalTermDocumentType_StandardEula - AwsMarketplaceCatalogLegalTermDocumentType_StandardDsa - AwsMarketplaceCatalogLegalTermDocumentType_StandardResellerContract - AwsMarketplaceCatalogLegalTermDocumentType_CustomResellerContract AwsMarketplaceCatalogPricingModel: enum: - Contract - Usage - Byol - Free - Unknown type: string x-enum-varnames: - AwsMarketplaceCatalogPricingModel_Contract - AwsMarketplaceCatalogPricingModel_Usage - AwsMarketplaceCatalogPricingModel_Byol - AwsMarketplaceCatalogPricingModel_Free - AwsMarketplaceCatalogPricingModel_Unknown AwsMarketplaceCatalogPricingTermRateCard: properties: Constraints: allOf: - $ref: '#/components/schemas/AwsMarketplaceCatalogPricingTermRateCardConstraints' description: 'Defines constraints on how the term can be configured by acceptors. Applicable only to ConfigurableUpfrontPricingTerm.' type: object RateCard: items: $ref: '#/components/schemas/AwsMarketplaceCatalogPricingTermRateCardItem' type: array Selector: allOf: - $ref: '#/components/schemas/AwsMarketplaceCatalogPricingTermRateCardSelector' description: 'Selector is used to differentiate between the mutually exclusive rate cards in the same pricing term, to be selected by the buyer. Applicable only to ConfigurableUpfrontPricingTerm.' type: object type: object AwsMarketplaceCatalogPricingTermRateCardConstraints: properties: MultipleDimensionSelection: description: 'Determines if buyers are allowed to select multiple dimensions in the rate card. Possible values are "Allowed" and "Disallowed". Default value is "Allowed".' type: string QuantityConfiguration: description: 'Determines if acceptors are allowed to configure quantity for each dimension in rate card. Possible values are "Allowed" and "Disallowed". Default value is "Allowed".' type: string type: object AwsMarketplaceCatalogPricingTermRateCardItem: properties: Description: type: string DimensionKey: type: string DisplayName: description: These fields are used for aws discovery API result. type: string Price: type: string Quantity: type: string Unit: type: string type: object AwsMarketplaceCatalogPricingTermRateCardSelector: properties: Type: description: At this time, only "Duration" is supported. type: string Value: description: ISO 8601 duration format. For example, "P1M" represents one month. type: string type: object AwsMarketplaceCppoDiscountType: enum: - DISCOUNT_PERCENT - CUSTOM_PRICE - CUSTOM_PRICE_WITH_FPS type: string x-enum-varnames: - AwsMarketplaceCppoDiscountType_DISCOUNT_PERCENT - AwsMarketplaceCppoDiscountType_CUSTOM_PRICE - AwsMarketplaceCppoDiscountType_FLEXIBLE_PAYMENT_SCHEDULE AwsMarketplaceCppoDurationType: enum: - SPECIFIC_DATES - ONE_TIME - NO_SET_TIME type: string x-enum-varnames: - AwsMarketplaceCppoDurationType_SPECIFIC_DATES - AwsMarketplaceCppoDurationType_ONE_TIME - AwsMarketplaceCppoDurationType_NO_SET_TIME AwsMarketplaceCppoOpportunity: properties: CreatedDate: type: string Description: type: string Dimensions: items: $ref: '#/components/schemas/AwsProductDimension' type: array ManufacturerAccountId: type: string ManufacturerLegalName: type: string Name: type: string OfferDetails: $ref: '#/components/schemas/AwsMarketplaceCppoOpportunityOfferDetails' PreExistingBuyerAgreement: $ref: '#/components/schemas/AwsMarketplacePreExistingAgreement' ProductId: type: string ProductName: type: string Rules: items: $ref: '#/components/schemas/AwsMarketplaceCppoOpportunityRule' type: array Status: enum: - Active - Restricted - Complete type: string Terms: items: $ref: '#/components/schemas/AwsMarketplaceCppoOpportunityTerm' type: array discountType: allOf: - $ref: '#/components/schemas/AwsMarketplaceCppoDiscountType' description: 'The following fields are not from aws catalog API, only used for cppo_out offer create. They shouldn''t be read in other places because they will absent when fetch opportunity from aws catalog API.' type: object opportunityDurationType: $ref: '#/components/schemas/AwsMarketplaceCppoDurationType' opportunityId: type: string partnerId: type: string type: object AwsMarketplaceCppoOpportunityNegativeTargeting: properties: CountryCodes: items: type: string type: array type: object AwsMarketplaceCppoOpportunityOfferDetails: properties: OfferCreatedCount: type: integer OfferExtendedStatus: type: string type: object AwsMarketplaceCppoOpportunityPaymentSchedule: properties: ChargeAmount: type: string ChargeDate: format: date-time type: string type: object AwsMarketplaceCppoOpportunityPositiveTargeting: properties: BuyerAccounts: description: List of AWS account IDs that are allowed to subscribe to the offer. items: $ref: '#/components/schemas/AwsMarketplaceBuyerAccount' type: array CountryCodes: description: 'List as option for allowing targeting based on country. If the intention isn''t to target the offer to a country, this field should be omitted. If it''s present, the list must contain at least one country code. Each element in this list should be a valid 2-letter country code, using this format: ISO 3166-1 alpha-2.' items: type: string type: array type: object AwsMarketplaceCppoOpportunityRule: properties: AvailabilityEndDate: type: string Id: description: Output only. type: string NegativeTargeting: allOf: - $ref: '#/components/schemas/AwsMarketplaceCppoOpportunityNegativeTargeting' description: Negative targeting defines the criteria which any customer's profile should fulfill to be restricted to access the offer. type: object OffersMaxQuantity: type: integer PositiveTargeting: allOf: - $ref: '#/components/schemas/AwsMarketplaceCppoOpportunityPositiveTargeting' description: Positive targeting defines the criteria which any buyer's profile should fulfill in order to be allowed to access the offer. type: object ResellerAccountId: type: string ResellerLegalName: type: string Type: $ref: '#/components/schemas/AwsMarketplaceCppoOpportunityRuleType' Usage: type: string type: object AwsMarketplaceCppoOpportunityRuleType: enum: - AvailabilityRule - PartnerTargetingRule - TargetingRule - TaxConfigurationRule type: string x-enum-varnames: - AwsMarketplaceCppoOpportunityRuleType_AvailabilityRule - AwsMarketplaceCppoOpportunityRuleType_PartnerTargetingRule - AwsMarketplaceCppoOpportunityRuleType_TargetingRule - AwsMarketplaceCppoOpportunityRuleType_TaxConfigurationRule AwsMarketplaceCppoOpportunityTerm: properties: CurrencyCode: type: string Documents: items: $ref: '#/components/schemas/AwsMarketplaceCatalogLegalTermDocument' type: array Duration: description: ISO 8601 duration format. For example, "P12M" represents 12 months. type: string Grants: items: $ref: '#/components/schemas/AwsMarketplaceCppoOpportunityUpfrontPriceGrant' type: array Id: type: string MaximumAgreementStartDate: type: string PositiveTargeting: $ref: '#/components/schemas/AwsMarketplaceCppoOpportunityPositiveTargeting' Price: description: For ResaleFixedUpfrontPricingTerm type: string RateCards: items: $ref: '#/components/schemas/AwsMarketplaceCatalogPricingTermRateCard' type: array Schedule: description: For ResalePaymentScheduleTerm items: $ref: '#/components/schemas/AwsMarketplaceCppoOpportunityPaymentSchedule' type: array Type: $ref: '#/components/schemas/AwsMarketplaceCppoOpportunityTermType' type: object AwsMarketplaceCppoOpportunityTermType: enum: - BuyerTargetingTerm - UpdateAvailability - BuyerValidityTerm - BuyerLegalTerm - ResaleLegalTerm - ResaleUsageBasedPricingTerm - ResaleConfigurableUpfrontPricingTerm - ResaleFixedUpfrontPricingTerm - ResalePaymentScheduleTerm type: string x-enum-varnames: - AwsMarketplaceCppoOpportunityTermType_BuyerTargetingTerm - AwsMarketplaceCppoOpportunityTermType_UpdateAvailability - AwsMarketplaceCppoOpportunityTermType_BuyerValidityTerm - AwsMarketplaceCppoOpportunityTermType_BuyerLegalTerm - AwsMarketplaceCppoOpportunityTermType_ResaleLegalTerm - AwsMarketplaceCppoOpportunityTermType_ResaleUsageBasedPricingTerm - AwsMarketplaceCppoOpportunityTermType_ResaleConfigurableUpfrontPricingTerm - AwsMarketplaceCppoOpportunityTermType_ResaleFixedUpfrontPricingTerm - AwsMarketplaceCppoOpportunityTermType_ResalePaymentScheduleTerm AwsMarketplaceCppoOpportunityUpfrontPriceGrant: properties: DimensionKey: type: string MaxQuantity: type: integer type: object AwsMarketplaceEventBridgeEventAccount: properties: accountId: type: string name: type: string type: object AwsMarketplaceEventBridgeEventDetail: properties: catalog: type: string eventCategory: type: string eventID: type: string eventName: type: string eventSource: type: string eventType: type: string eventVersion: type: string managementEvent: type: boolean manufacturer: allOf: - $ref: '#/components/schemas/AwsMarketplaceEventBridgeEventAccount' description: The seller/ISV's AWS Account Id. type: object offer: $ref: '#/components/schemas/AwsMarketplaceEventBridgeEventOffer' product: $ref: '#/components/schemas/AwsMarketplaceEventBridgeEventProduct' requestID: type: string requestParameters: type: object responseElements: type: object sellerOfRecord: allOf: - $ref: '#/components/schemas/AwsMarketplaceEventBridgeEventAccount' description: 'For private offer created by a channel partner, this is the channel partner''s AWS Account Id. For private offer created by a seller/ISV, this is the seller/ISV''s AWS Account Id.' type: object targetedBuyerAccountIds: items: type: string type: array type: object AwsMarketplaceEventBridgeEventOffer: properties: arn: type: string expirationDate: format: date-time type: string id: type: string name: type: string type: object AwsMarketplaceEventBridgeEventProduct: properties: arn: type: string id: type: string title: type: string type: object AwsMarketplaceMeteringBatchMeterUsageInput: properties: ProductCode: description: 'Product code is used to uniquely identify a product in AWS Marketplace. The product code should be the same as the one used during the publishing of a new product.' type: string UsageRecords: description: The set of UsageRecords to submit. BatchMeterUsage accepts up to 25 UsageRecords at a time. items: $ref: '#/components/schemas/AwsMarketplaceMeteringUsageRecord' type: array type: object AwsMarketplaceMeteringTag: properties: Key: description: 'One part of a key-value pair that makes up a tag. A key is a label that acts like a category for the specific tag values.' type: string Value: description: 'One part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key). The value can be empty or null.' type: string type: object AwsMarketplaceMeteringUsageAllocation: properties: AllocatedUsageQuantity: description: The total quantity allocated to this bucket of usage. type: integer Tags: description: 'The set of tags that define the bucket of usage. For the bucket of items with no tags, this parameter can be left out.' items: $ref: '#/components/schemas/AwsMarketplaceMeteringTag' type: array type: object AwsMarketplaceMeteringUsageRecord: properties: CustomerIdentifier: description: 'The CustomerIdentifier is obtained through the ResolveCustomer operation and represents an individual buyer in your application.' type: string Dimension: description: 'During the process of registering a product on AWS Marketplace, dimensions are specified. These represent different units of value in your application.' type: string Quantity: description: 'The quantity of usage consumed by the customer for the given dimension and time. Defaults to 0 if not specified.' type: integer Timestamp: description: 'Timestamp, in UTC, for which the usage is being reported. Your application can meter usage for up to one hour in the past. Make sure the timestamp value is not before the start of the software usage.' format: date-time type: string UsageAllocations: description: 'The set of UsageAllocations to submit. The sum of all UsageAllocation quantities must equal the Quantity of the UsageRecord.' items: $ref: '#/components/schemas/AwsMarketplaceMeteringUsageAllocation' type: array type: object AwsMarketplacePreExistingAgreement: properties: AcquisitionChannel: allOf: - $ref: '#/components/schemas/AwsRenewalOfferType' description: 'Indicates if the existing agreement was signed outside AWS Marketplace or within AWS Marketplace. one of values ["External", "AwsMarketplace"]' type: object PricingModel: allOf: - $ref: '#/components/schemas/AwsMarketplaceCatalogPricingModel' description: Indicates which pricing model the existing agreement uses. type: object type: object AwsMarketplaceProductVisibility: enum: - Limited - Public - Restricted - Unavailable - Draft type: string x-enum-varnames: - AwsMarketplaceProductVisibility_Limited - AwsMarketplaceProductVisibility_Public - AwsMarketplaceProductVisibility_Restricted - AwsMarketplaceProductVisibility_Unavailable - AwsMarketplaceProductVisibility_Draft AwsProduct: example: Repositories: - Type: Type Url: Url - Type: Type Url: Url Description: UsW9Submitted: true Highlights: - Highlights - Highlights Categories: - Categories - Categories ProductCode: ProductCode SearchKeywords: - SearchKeywords - SearchKeywords ProductTitle: ProductTitle EuW8Submitted: true ShortDescription: ShortDescription LongDescription: LongDescription Manufacturer: Manufacturer Visibility: Limited AssociatedProducts: '{}' Sku: Sku Registered: true Versions: - CreationDate: 2000-01-23 04:56:07+00:00 Id: Id DeliveryOptions: - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription ReleaseNotes: ReleaseNotes VersionTitle: VersionTitle - CreationDate: 2000-01-23 04:56:07+00:00 Id: Id DeliveryOptions: - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription ReleaseNotes: ReleaseNotes VersionTitle: VersionTitle productId: productId PromotionalResources: AdditionalResources: - Type: Type Text: Text Url: Url - Type: Type Text: Text Url: Url LogoUrl: LogoUrl Videos: - Type: Type Title: Title Url: Url - Type: Type Title: Title Url: Url dataFeedProductId: dataFeedProductId Dimensions: - Types: - Types - Types Description: Description Length: 2 Rate: 6.778324963048013 TimeUnit: DAY Unit: Unit Key: Key Name: Name - Types: - Types - Types Description: Description Length: 2 Rate: 6.778324963048013 TimeUnit: DAY Unit: Unit Key: Key Name: Name SignatureVerificationKeys: - Status: Status PublicKey: PublicKey PublicKeyVersion: 2 - Status: Status PublicKey: PublicKey PublicKeyVersion: 2 SupportInformation: Description: Description properties: Description: $ref: '#/components/schemas/AwsProductDescription' Dimensions: items: $ref: '#/components/schemas/AwsProductDimension' type: array PromotionalResources: $ref: '#/components/schemas/AwsProductPromotionalResources' Repositories: items: $ref: '#/components/schemas/AwsProductRepository' type: array SignatureVerificationKeys: items: $ref: '#/components/schemas/AwsProductSignatureVerificationKey' type: array SupportInformation: $ref: '#/components/schemas/AwsProductSupportInformation' Versions: items: $ref: '#/components/schemas/AwsProductVersion' type: array dataFeedProductId: description: The product Id in AWS Marketplace Data Feed Service. type: string productId: description: AWS Product ID type: string type: object AwsProductAdditionalResource: example: Type: Type Text: Text Url: Url properties: Text: type: string Type: type: string Url: type: string type: object AwsProductDeliveryOption: example: Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription properties: AmiAlias: description: Exclusive Fields For AWS AMI Product type: string FulfillmentUrl: description: Exclusive Fields For AWS SaaS Product type: string Id: type: string Recommendations: type: object ShortDescription: type: string SourceId: type: string Title: description: Exclusive Fields For AWS Container Product type: string Type: type: string Visibility: type: string type: object AwsProductDescription: example: UsW9Submitted: true Highlights: - Highlights - Highlights Categories: - Categories - Categories ProductCode: ProductCode SearchKeywords: - SearchKeywords - SearchKeywords ProductTitle: ProductTitle EuW8Submitted: true ShortDescription: ShortDescription LongDescription: LongDescription Manufacturer: Manufacturer Visibility: Limited AssociatedProducts: '{}' Sku: Sku Registered: true properties: AssociatedProducts: type: object Categories: items: type: string type: array EuW8Submitted: type: boolean Highlights: items: type: string type: array LongDescription: type: string Manufacturer: type: string ProductCode: type: string ProductTitle: type: string Registered: type: boolean SearchKeywords: items: type: string type: array ShortDescription: type: string Sku: type: string UsW9Submitted: type: boolean Visibility: $ref: '#/components/schemas/AwsMarketplaceProductVisibility' type: object AwsProductDimension: example: Types: - Types - Types Description: Description Length: 2 Rate: 6.778324963048013 TimeUnit: DAY Unit: Unit Key: Key Name: Name properties: Description: type: string Key: type: string Length: description: 'The term length for the commit amount, such as 6 months, or 1 year. The length is used together with timeUnit. Length and TimeUnit are only used for commit dimension.' type: integer Name: type: string Rate: description: 'Below three fields are only used for pass data when create or update product''s public offer pricing. Rate is only used for update public offer, becasue rate will be set as 0.01 when create new product.' type: number TimeUnit: $ref: '#/components/schemas/TimeUnit' Types: items: type: string type: array Unit: type: string type: object AwsProductPromotionalResources: example: AdditionalResources: - Type: Type Text: Text Url: Url - Type: Type Text: Text Url: Url LogoUrl: LogoUrl Videos: - Type: Type Title: Title Url: Url - Type: Type Title: Title Url: Url properties: AdditionalResources: items: $ref: '#/components/schemas/AwsProductAdditionalResource' type: array LogoUrl: type: string Videos: items: $ref: '#/components/schemas/AwsProductVideo' type: array type: object AwsProductRepository: example: Type: Type Url: Url properties: Type: type: string Url: type: string type: object AwsProductSignatureVerificationKey: example: Status: Status PublicKey: PublicKey PublicKeyVersion: 2 properties: PublicKey: type: string PublicKeyVersion: type: integer Status: type: string type: object AwsProductSupportInformation: example: Description: Description properties: Description: type: string type: object AwsProductVersion: example: CreationDate: 2000-01-23 04:56:07+00:00 Id: Id DeliveryOptions: - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription ReleaseNotes: ReleaseNotes VersionTitle: VersionTitle properties: CreationDate: format: date-time type: string DeliveryOptions: items: $ref: '#/components/schemas/AwsProductDeliveryOption' type: array Id: type: string ReleaseNotes: type: string VersionTitle: type: string type: object AwsProductVideo: example: Type: Type Title: Title Url: Url properties: Title: type: string Type: type: string Url: type: string type: object AwsRenewalOfferType: enum: - '' - External - AwsMarketplace type: string x-enum-varnames: - AwsRenewalOfferType_Unknown - AwsRenewalOfferType_External - AwsRenewalOfferType_AwsMarketplace AwsSnsSubscription: example: Status: UNKNOWN Endpoint: Endpoint TopicArn: TopicArn Protocol: Protocol SubscriptionArn: SubscriptionArn properties: Endpoint: type: string Protocol: type: string Status: $ref: '#/components/schemas/AwsSnsSubscriptionStatus' SubscriptionArn: type: string TopicArn: type: string type: object AwsSnsSubscriptionStatus: enum: - UNKNOWN - CONFIRMED - PENDING_CONFIRMATION type: string x-enum-varnames: - AwsSnsSubscriptionStatus_UNKNOWN - AwsSnsSubscriptionStatus_CONFIRMED - AwsSnsSubscriptionStatus_PENDING_CONFIRMATION AzureADIdentifier: example: firstName: firstName lastName: lastName licenseType: licenseType puid: puid customerId: customerId tenantId: tenantId billingAccountId: billingAccountId emailId: emailId objectId: objectId properties: billingAccountId: description: Azure Billing Account ID type: string customerId: type: string emailId: description: Email address type: string firstName: type: string lastName: type: string licenseType: description: Azure License Type type: string objectId: type: string puid: description: ID of the user, used as External ID of suger IdentityBuyer. type: string tenantId: type: string type: object AzureAudience: example: description: description id: id properties: description: type: string id: type: string type: object AzureCommercialMarketplaceSetup: example: product: product $schema: $schema accessUrl: accessUrl useMicrosoftLicenseManagementService: true sellThroughMicrosoft: true resourceName: resourceName id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message requireLicenseForInstall: true callToAction: free properties: $schema: type: string accessUrl: description: in patern of "^(http|https)://" type: string callToAction: enum: - free - freeTrial - contactMe type: string id: description: In format of "commercial-marketplace-setup/setup-durable-id" type: string product: description: Product resource name, in format of "product/product-durable-id" type: string requireLicenseForInstall: type: boolean resourceName: type: string sellThroughMicrosoft: type: boolean useMicrosoftLicenseManagementService: description: If true, only per_user pricing model is allowed. type: boolean validations: items: $ref: '#/components/schemas/AzureMarketplaceValidation' type: array type: object AzureGovernmentCertification: example: validationResults: - errorMessage: errorMessage memberNames: - memberNames - memberNames - errorMessage: errorMessage memberNames: - memberNames - memberNames title: title uri: uri properties: title: type: string uri: type: string validationResults: items: $ref: '#/components/schemas/AzureValidationResult' type: array type: object AzureIncludedBaseQuantity: example: quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly properties: isInfinite: type: boolean quantity: type: number recurringUnit: enum: - Monthly - Annual type: string type: object AzureListingContact: example: phone: phone name: name type: CustomerSupport uri: uri email: email properties: email: type: string name: type: string phone: type: string type: enum: - CustomerSupport - Engineering - ChannelManager type: string uri: type: string type: object AzureListingUri: example: displayText: displayText subtype: subtype type: type uri: uri properties: displayText: type: string subtype: type: string type: type: string uri: type: string type: object AzureLocalizedDateTime: example: dateTimeInUtc: dateTimeInUtc localizePerMarket: true properties: dateTimeInUtc: type: string localizePerMarket: type: boolean type: object AzureLocalizedTimeRange: example: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true properties: endAt: $ref: '#/components/schemas/AzureLocalizedDateTime' startAt: $ref: '#/components/schemas/AzureLocalizedDateTime' type: object AzureMarket: example: marketCode: marketCode friendlyName: friendlyName properties: friendlyName: type: string marketCode: description: ISO Country Code type: string type: object AzureMarketState: example: marketCode: marketCode state: Disabled properties: marketCode: description: ISO Country Code type: string state: enum: - Disabled - Enabled - StopSelling - Terminated type: string type: object AzureMarketplaceContact: example: phone: phone name: name email: email url: url properties: email: type: string name: type: string phone: type: string url: description: in patern of "^(http|https)://" type: string type: object AzureMarketplaceCustomAmendment: example: tenants: manualEntries: - description: description id: id - description: description id: id terms: terms properties: tenants: $ref: '#/components/schemas/AzureMarketplaceCustomAmendmentTenant' terms: type: string type: object AzureMarketplaceCustomAmendmentTenant: example: manualEntries: - description: description id: id - description: description id: id properties: manualEntries: items: $ref: '#/components/schemas/AzureMarketplaceCustomAmendmentTenantManualEntry' type: array type: object AzureMarketplaceCustomAmendmentTenantManualEntry: example: description: description id: id properties: description: type: string id: type: string type: object AzureMarketplaceCustomerLeads: example: salesforceLeadConfiguration: '{}' product: product $schema: $schema tableLeadConfiguration: '{}' httpsEndpointLeadConfiguration: '{}' resourceName: resourceName emailLeadConfiguration: '{}' dynamicsLeadConfiguration: '{}' marketoLeadConfiguration: '{}' leadDestination: none id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message blobLeadConfiguration: '{}' properties: $schema: type: string blobLeadConfiguration: type: object dynamicsLeadConfiguration: type: object emailLeadConfiguration: type: object httpsEndpointLeadConfiguration: type: object id: type: string leadDestination: enum: - none - blob - dynamics - email - httpsEndpoint - marketo - salesforce - table type: string marketoLeadConfiguration: type: object product: type: string resourceName: type: string salesforceLeadConfiguration: type: object tableLeadConfiguration: type: object validations: items: $ref: '#/components/schemas/AzureMarketplaceValidation' type: array type: object AzureMarketplaceDeprecationSchedule: example: date: date reason: criticalSecurityIssue $schema: $schema alternative: product: '{}' plan: '{}' dateOffset: dateOffset properties: $schema: type: string alternative: $ref: '#/components/schemas/AzureMarketplaceDeprecationScheduleAlternative' date: description: 'format: date-time' type: string dateOffset: description: 'format: duration' type: string reason: enum: - criticalSecurityIssue - endOfSupport - other type: string type: object AzureMarketplaceDeprecationScheduleAlternative: example: product: '{}' plan: '{}' properties: plan: type: object product: type: object type: object AzureMarketplaceGeneralLink: example: displayText: displayText link: link properties: displayText: type: string link: description: in patern of "^(http|https)://" type: string type: object AzureMarketplaceGovernmentCertification: example: link: link name: name properties: link: description: in patern of "^(http|https)://" type: string name: type: string type: object AzureMarketplaceIdentity: example: externalId: externalId properties: externalId: type: string type: object AzureMarketplaceListing: example: generalLinks: - displayText: displayText link: link - displayText: displayText link: link lifecycleState: '{}' cloudSolutionProviderMarketingMaterials: cloudSolutionProviderMarketingMaterials product: product supportContact: phone: phone name: name email: email url: url governmentSupportWebsite: governmentSupportWebsite $schema: $schema searchKeywords: - searchKeywords - searchKeywords kind: azureSaaS languageId: languageId description: description resourceName: resourceName shortDescription: shortDescription title: title privacyPolicyLink: privacyPolicyLink gettingStartedInstructions: gettingStartedInstructions gloabalSupportWebsite: gloabalSupportWebsite cloudSolutionProviderContact: phone: phone name: name email: email url: url engineeringContact: phone: phone name: name email: email url: url id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message searchResultSummary: searchResultSummary properties: $schema: type: string cloudSolutionProviderContact: $ref: '#/components/schemas/AzureMarketplaceContact' cloudSolutionProviderMarketingMaterials: type: string description: type: string engineeringContact: $ref: '#/components/schemas/AzureMarketplaceContact' generalLinks: items: $ref: '#/components/schemas/AzureMarketplaceGeneralLink' type: array gettingStartedInstructions: type: string gloabalSupportWebsite: type: string governmentSupportWebsite: type: string id: type: string kind: enum: - azureSaaS - azureVM - xbox360NonBackCompat type: string languageId: type: string lifecycleState: allOf: - $ref: '#/components/schemas/AzureMarketplaceResourceLifecycleState' description: Default value is "generallyAvailable". type: object privacyPolicyLink: type: string product: description: Product resource name, in format of "product/product-durable-id" type: string resourceName: type: string searchKeywords: items: type: string type: array searchResultSummary: type: string shortDescription: type: string supportContact: $ref: '#/components/schemas/AzureMarketplaceContact' title: description: Max string length is 200. type: string validations: items: $ref: '#/components/schemas/AzureMarketplaceValidation' type: array type: object AzureMarketplaceListingAsset: example: lifecycleState: '{}' fileName: fileName product: product $schema: $schema kind: azure displayOrder: 6 languageId: languageId description: description resourceName: resourceName type: azureLogoSmall url: url id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message listing: listing friendlyName: friendlyName properties: $schema: type: string description: type: string displayOrder: description: 'minimum: 0' type: integer fileName: type: string friendlyName: type: string id: type: string kind: enum: - azure type: string languageId: description: Max string length is 10. type: string lifecycleState: allOf: - $ref: '#/components/schemas/AzureMarketplaceResourceLifecycleState' description: Default value is "generallyAvailable". type: object listing: type: string product: description: Product resource name, in format of "product/product-durable-id" type: string resourceName: type: string type: $ref: '#/components/schemas/AzureMarketplaceListingAssetType' url: description: 'pattern: "^https?://"' type: string validations: items: $ref: '#/components/schemas/AzureMarketplaceValidation' type: array type: object AzureMarketplaceListingAssetType: enum: - azureLogoSmall - azureLogoMedium - azureLogoLarge - azureLogoWide - azureLogoScreenshot - azureLogoHero - pdfDocument type: string x-enum-varnames: - AzureMarketplaceListingAssetType_AzureLogoSmall - AzureMarketplaceListingAssetType_AzureLogoMedium - AzureMarketplaceListingAssetType_AzureLogoLarge - AzureMarketplaceListingAssetType_AzureLogoWide - AzureMarketplaceListingAssetType_AzureLogoScreenshot - AzureMarketplaceListingAssetType_AzureLogoHero - AzureMarketplaceListingAssetType_PdfDocument AzureMarketplaceMeteringBatchUsageEvent: properties: request: items: $ref: '#/components/schemas/AzureMarketplaceMeteringUsageEvent' type: array type: object AzureMarketplaceMeteringUsageEvent: properties: dimension: description: Dimension identifier type: string effectiveStartTime: description: Time in UTC when the usage event occurred type: string planId: description: Plan associated with the purchased offer type: string quantity: description: Number of units consumed type: number resourceId: description: 'subscriptionId property value for SaaS offer subscriptions; resourceUsageId property on the managed application resource for managed application offers. For managed applications, only use one of resourceId or resourceUri.' type: string resourceUri: description: Resource URI for the managed app. Used with managed applications. Only use resourceUri or resourceId, but never both. type: string type: object AzureMarketplaceOfferPricingType: enum: - '' - editExistingOfferPricingOnly - saasNewCustomizedPlans - vmSoftwareReservations - newCustomizedPlans type: string x-enum-varnames: - AzureMarketplaceOfferPricingType_Unknown - AzureMarketplaceOfferPricingType_EditExistingOfferPricingOnly - AzureMarketplaceOfferPricingType_SaasNewCustomizedPlans - AzureMarketplaceOfferPricingType_VmSoftwareReservations - AzureMarketplaceOfferPricingType_NewCustomizedPlans AzureMarketplacePlan: example: deprecationSchedule: date: date reason: criticalSecurityIssue $schema: $schema alternative: product: '{}' plan: '{}' dateOffset: dateOffset lifecycleState: null product: product displayRank: 3 $schema: $schema azureGovernmentCertifications: - link: link name: name - link: link name: name resourceName: resourceName azureRegions: - azureRegions - azureRegions subtype: managedApplication identity: externalId: externalId alias: alias id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message properties: $schema: type: string alias: type: string azureGovernmentCertifications: items: $ref: '#/components/schemas/AzureMarketplaceGovernmentCertification' type: array azureRegions: description: enums:[azureGlobal,azureGovernment,azureGermany,azureChina] items: type: string type: array deprecationSchedule: $ref: '#/components/schemas/AzureMarketplaceDeprecationSchedule' displayRank: description: default 2147483647 type: integer id: description: in format of "plan/product-durable-id/plan-durable-id" type: string identity: $ref: '#/components/schemas/AzureMarketplaceIdentity' lifecycleState: $ref: '#/components/schemas/AzureMarketplaceResourceLifecycleState' product: description: in format of "product/product-durable-id" type: string resourceName: type: string subtype: description: 'Specifies the plan type (AzureApplication-type products only) see: https://go.microsoft.com/fwlink/?linkid=2106322' enum: - managedApplication - solutionTemplate type: string validations: items: $ref: '#/components/schemas/AzureMarketplaceValidation' type: array type: object AzureMarketplacePlanListing: example: summary: summary lifecycleState: null product: product $schema: $schema kind: azureVM-plan languageId: languageId name: name description: description resourceName: resourceName id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message plan: plan properties: $schema: type: string description: type: string id: type: string kind: enum: - azureVM-plan - azureSaaS-plan - azureCoreVM-plan - azureContainer-plan type: string languageId: type: string lifecycleState: $ref: '#/components/schemas/AzureMarketplaceResourceLifecycleState' name: type: string plan: type: string product: type: string resourceName: type: string summary: type: string validations: items: $ref: '#/components/schemas/AzureMarketplaceValidation' type: array type: object AzureMarketplacePlanResource: example: planListing: summary: summary lifecycleState: null product: product $schema: $schema kind: azureVM-plan languageId: languageId name: name description: description resourceName: resourceName id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message plan: plan priceAndAvailabilityPlan: audience: public product: product softwareReservation: - percentageSave: 6.704019297950036 term: 3.353193347011243 type: month - percentageSave: 6.704019297950036 term: 3.353193347011243 type: month $schema: $schema visibility: visible meterDefine: meterDefine billingTag: billingTag resourceName: resourceName trial: type: day value: 7.386281948385884 markets: - markets - markets privateAudiences: - id: id label: label type: none - id: id label: label type: none id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message plan: plan pricing: customMeters: priceInputOption: perMarket meters: key: pricePerPaymentInUsd: 6.778324963048013 includedQuantities: - quantity: 2.8841621266687802 isInfinite: true billingTerm: type: day value: 7.386281948385884 - quantity: 2.8841621266687802 isInfinite: true billingTerm: type: day value: 7.386281948385884 billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - pricePerPaymentInUsd: 6.878052220127876 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency - pricePerPaymentInUsd: 6.878052220127876 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency licenseModel: byol systemMeterPricing: price: 5.944895607614016 priceInputOption: perCore prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency corePricing: price: 6.965117697638846 priceInputOption: free pricePerCoreSize: '{}' pricePerCore: 1.284659006116532 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency recurrentPrice: recurrentPriceMode: flatRate userLimits: min: 6.84685269835264 max: 1.4894159098541704 priceInputOption: perMarket prices: - billingFrequency: '{}' pricePerPaymentInUsd: 1.2315135367772556 flexibleSchedule: '{}' contractDuration: '{}' billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency - billingFrequency: '{}' pricePerPaymentInUsd: 1.2315135367772556 flexibleSchedule: '{}' contractDuration: '{}' billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency plan: deprecationSchedule: date: date reason: criticalSecurityIssue $schema: $schema alternative: product: '{}' plan: '{}' dateOffset: dateOffset lifecycleState: null product: product displayRank: 3 $schema: $schema azureGovernmentCertifications: - link: link name: name - link: link name: name resourceName: resourceName azureRegions: - azureRegions - azureRegions subtype: managedApplication identity: externalId: externalId alias: alias id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message properties: plan: $ref: '#/components/schemas/AzureMarketplacePlan' planListing: $ref: '#/components/schemas/AzureMarketplacePlanListing' priceAndAvailabilityPlan: $ref: '#/components/schemas/AzureMarketplacePriceAndAvailabilityPlan' type: object AzureMarketplacePreviewAudience: example: resourceId: resourceId description: description type: subscription properties: description: type: string resourceId: type: string type: enum: - subscription type: string type: object AzureMarketplacePrice: example: markets: - markets - markets price: 1.0246457001441578 currency: currency properties: currency: description: ISO 4217 currency code type: string markets: description: PriceAndAvailability audience definition items: type: string type: array price: description: Prices interface{} `json:"prices,omitempty"` type: number type: object AzureMarketplacePriceAndAvailabilityAudience: example: id: id label: label type: none properties: id: type: string label: type: string type: enum: - none - subscription - ea - msdn - tenant - email type: string type: object AzureMarketplacePriceAndAvailabilityCorePrice: example: price: 6.965117697638846 priceInputOption: free pricePerCoreSize: '{}' pricePerCore: 1.284659006116532 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency properties: price: type: number priceInputOption: enum: - free - flat - perCore - perCoreSize - perMarketAndCoreSize type: string pricePerCore: type: number pricePerCoreSize: type: object prices: items: $ref: '#/components/schemas/AzureMarketplacePrice' type: array type: object AzureMarketplacePriceAndAvailabilityCustomMeter: example: product: product $schema: $schema customMeters: key: unitOfMeasure: unitOfMeasure displayName: displayName price: 3.0937452626664474 resourceName: resourceName id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message properties: $schema: type: string customMeters: additionalProperties: $ref: '#/components/schemas/AzureMarketplacePriceAndAvailabilityCustomMeterItem' type: object id: type: string product: type: string resourceName: type: string validations: items: $ref: '#/components/schemas/AzureMarketplaceValidation' type: array type: object AzureMarketplacePriceAndAvailabilityCustomMeterItem: example: unitOfMeasure: unitOfMeasure displayName: displayName price: 3.0937452626664474 properties: displayName: type: string price: description: Suger's custom field, for Suger internal use only. Not from Microsoft official schema. type: number unitOfMeasure: type: string type: object AzureMarketplacePriceAndAvailabilityCustomMeterPrice: example: priceInputOption: perMarket meters: key: pricePerPaymentInUsd: 6.778324963048013 includedQuantities: - quantity: 2.8841621266687802 isInfinite: true billingTerm: type: day value: 7.386281948385884 - quantity: 2.8841621266687802 isInfinite: true billingTerm: type: day value: 7.386281948385884 billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - pricePerPaymentInUsd: 6.878052220127876 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency - pricePerPaymentInUsd: 6.878052220127876 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency properties: meters: additionalProperties: $ref: '#/components/schemas/AzureMarketplacePriceAndAvailabilityCustomMeterPriceMeterItem' type: object priceInputOption: description: default "usd" enum: - perMarket - usd type: string type: object AzureMarketplacePriceAndAvailabilityCustomMeterPriceIncludedQuantityItem: example: quantity: 2.8841621266687802 isInfinite: true billingTerm: type: day value: 7.386281948385884 properties: billingTerm: $ref: '#/components/schemas/AzureMarketplaceTerm' isInfinite: type: boolean quantity: type: number type: object AzureMarketplacePriceAndAvailabilityCustomMeterPriceMeter: additionalProperties: $ref: '#/components/schemas/AzureMarketplacePriceAndAvailabilityCustomMeterPriceMeterItem' type: object AzureMarketplacePriceAndAvailabilityCustomMeterPriceMeterItem: example: pricePerPaymentInUsd: 6.778324963048013 includedQuantities: - quantity: 2.8841621266687802 isInfinite: true billingTerm: type: day value: 7.386281948385884 - quantity: 2.8841621266687802 isInfinite: true billingTerm: type: day value: 7.386281948385884 billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - pricePerPaymentInUsd: 6.878052220127876 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency - pricePerPaymentInUsd: 6.878052220127876 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency properties: billingTerm: $ref: '#/components/schemas/AzureMarketplaceTerm' includedQuantities: items: $ref: '#/components/schemas/AzureMarketplacePriceAndAvailabilityCustomMeterPriceIncludedQuantityItem' type: array paymentOption: $ref: '#/components/schemas/AzureMarketplaceTerm' pricePerPaymentInUsd: type: number prices: items: $ref: '#/components/schemas/AzureMarketplacePriceAndAvailabilityCustomMeterPriceMeterItemPriceItem' type: array type: object AzureMarketplacePriceAndAvailabilityCustomMeterPriceMeterItemPriceItem: example: pricePerPaymentInUsd: 6.878052220127876 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency properties: pricePerPaymentInUsd: type: number prices: items: $ref: '#/components/schemas/AzureMarketplacePrice' type: array type: object AzureMarketplacePriceAndAvailabilityOffer: example: product: product $schema: $schema previewAudiences: - id: id label: label type: none - id: id label: label type: none resourceName: resourceName id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message properties: $schema: type: string id: type: string previewAudiences: items: $ref: '#/components/schemas/AzureMarketplacePriceAndAvailabilityAudience' type: array product: type: string resourceName: type: string validations: items: $ref: '#/components/schemas/AzureMarketplaceValidation' type: array type: object AzureMarketplacePriceAndAvailabilityPlan: example: audience: public product: product softwareReservation: - percentageSave: 6.704019297950036 term: 3.353193347011243 type: month - percentageSave: 6.704019297950036 term: 3.353193347011243 type: month $schema: $schema visibility: visible meterDefine: meterDefine billingTag: billingTag resourceName: resourceName trial: type: day value: 7.386281948385884 markets: - markets - markets privateAudiences: - id: id label: label type: none - id: id label: label type: none id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message plan: plan pricing: customMeters: priceInputOption: perMarket meters: key: pricePerPaymentInUsd: 6.778324963048013 includedQuantities: - quantity: 2.8841621266687802 isInfinite: true billingTerm: type: day value: 7.386281948385884 - quantity: 2.8841621266687802 isInfinite: true billingTerm: type: day value: 7.386281948385884 billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - pricePerPaymentInUsd: 6.878052220127876 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency - pricePerPaymentInUsd: 6.878052220127876 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency licenseModel: byol systemMeterPricing: price: 5.944895607614016 priceInputOption: perCore prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency corePricing: price: 6.965117697638846 priceInputOption: free pricePerCoreSize: '{}' pricePerCore: 1.284659006116532 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency recurrentPrice: recurrentPriceMode: flatRate userLimits: min: 6.84685269835264 max: 1.4894159098541704 priceInputOption: perMarket prices: - billingFrequency: '{}' pricePerPaymentInUsd: 1.2315135367772556 flexibleSchedule: '{}' contractDuration: '{}' billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency - billingFrequency: '{}' pricePerPaymentInUsd: 1.2315135367772556 flexibleSchedule: '{}' contractDuration: '{}' billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency properties: $schema: type: string audience: enum: - public - private type: string billingTag: type: string id: type: string markets: items: type: string type: array meterDefine: type: string plan: type: string pricing: $ref: '#/components/schemas/AzureMarketplacePriceAndAvailabilityPrice' privateAudiences: items: $ref: '#/components/schemas/AzureMarketplacePriceAndAvailabilityAudience' type: array product: type: string resourceName: type: string softwareReservation: items: $ref: '#/components/schemas/AzureMarketplacePriceAndAvailabilitySoftwareReservation' type: array trial: $ref: '#/components/schemas/AzureMarketplaceTerm' validations: items: $ref: '#/components/schemas/AzureMarketplaceValidation' type: array visibility: enum: - visible - hidden type: string type: object AzureMarketplacePriceAndAvailabilityPrice: example: customMeters: priceInputOption: perMarket meters: key: pricePerPaymentInUsd: 6.778324963048013 includedQuantities: - quantity: 2.8841621266687802 isInfinite: true billingTerm: type: day value: 7.386281948385884 - quantity: 2.8841621266687802 isInfinite: true billingTerm: type: day value: 7.386281948385884 billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - pricePerPaymentInUsd: 6.878052220127876 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency - pricePerPaymentInUsd: 6.878052220127876 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency licenseModel: byol systemMeterPricing: price: 5.944895607614016 priceInputOption: perCore prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency corePricing: price: 6.965117697638846 priceInputOption: free pricePerCoreSize: '{}' pricePerCore: 1.284659006116532 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency recurrentPrice: recurrentPriceMode: flatRate userLimits: min: 6.84685269835264 max: 1.4894159098541704 priceInputOption: perMarket prices: - billingFrequency: '{}' pricePerPaymentInUsd: 1.2315135367772556 flexibleSchedule: '{}' contractDuration: '{}' billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency - billingFrequency: '{}' pricePerPaymentInUsd: 1.2315135367772556 flexibleSchedule: '{}' contractDuration: '{}' billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency properties: corePricing: $ref: '#/components/schemas/AzureMarketplacePriceAndAvailabilityCorePrice' customMeters: $ref: '#/components/schemas/AzureMarketplacePriceAndAvailabilityCustomMeterPrice' licenseModel: enum: - byol - payAsYouGo type: string recurrentPrice: $ref: '#/components/schemas/AzureMarketplacePriceAndAvailabilityRecurrentPrice' systemMeterPricing: $ref: '#/components/schemas/AzureMarketplacePriceAndAvailabilitySystemMeterPrice' type: object AzureMarketplacePriceAndAvailabilityPrivateOfferCustomMeters: example: priceInputOption: perMarket meters: '{}' properties: meters: description: One of PriceAndAvailabilityCustomMeter_USD or PriceAndAvailabilityCustomMeter_PerMarket type: object priceInputOption: description: default "usd" enum: - perMarket - usd type: string type: object AzureMarketplacePriceAndAvailabilityPrivateOfferPlan: example: lifecycleState: notAvailable product: product softwareReservation: paymentSchedule: type: day value: 7.386281948385884 reservationDuration: type: day value: 7.386281948385884 vmPrices: patternProperties: key: quantity: 7.457744773683766 unitPricePerPaymentPeriodInUsd: 1.1730742509559433 $schema: $schema offerPricingType: '{}' visibility: visible planName: planName resourceName: resourceName id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message plan: plan pricing: customMeters: priceInputOption: perMarket meters: '{}' recurrentPrice: recurrentPriceMode: flatRate userLimits: min: 6.84685269835264 max: 1.4894159098541704 priceInputOption: perMarket prices: - billingFrequency: '{}' pricePerPaymentInUsd: 1.2315135367772556 flexibleSchedule: '{}' contractDuration: '{}' billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency - billingFrequency: '{}' pricePerPaymentInUsd: 1.2315135367772556 flexibleSchedule: '{}' contractDuration: '{}' billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency properties: $schema: type: string id: type: string lifecycleState: $ref: '#/components/schemas/AzureMarketplaceResourceLifecycleState' offerPricingType: allOf: - $ref: '#/components/schemas/AzureMarketplaceOfferPricingType' description: default "editExistingOfferPricingOnly" type: object plan: type: string planName: description: The azure plan friendly name, from the Azure Marketplace. type: string pricing: $ref: '#/components/schemas/AzureMarketplacePriceAndAvailabilityPrivateOfferPrice' product: type: string resourceName: type: string softwareReservation: $ref: '#/components/schemas/AzureMarketplacePriceAndAvailabilityPrivateOfferPlanSoftwareReservation' validations: items: $ref: '#/components/schemas/AzureMarketplaceValidation' type: array visibility: description: default "visible" enum: - visible - hidden type: string type: object AzureMarketplacePriceAndAvailabilityPrivateOfferPlanSoftwareReservation: example: paymentSchedule: type: day value: 7.386281948385884 reservationDuration: type: day value: 7.386281948385884 vmPrices: patternProperties: key: quantity: 7.457744773683766 unitPricePerPaymentPeriodInUsd: 1.1730742509559433 properties: paymentSchedule: $ref: '#/components/schemas/AzureMarketplaceTerm' reservationDuration: $ref: '#/components/schemas/AzureMarketplaceTerm' vmPrices: $ref: '#/components/schemas/AzureMarketplaceVmPrice' type: object AzureMarketplacePriceAndAvailabilityPrivateOfferPrice: example: customMeters: priceInputOption: perMarket meters: '{}' recurrentPrice: recurrentPriceMode: flatRate userLimits: min: 6.84685269835264 max: 1.4894159098541704 priceInputOption: perMarket prices: - billingFrequency: '{}' pricePerPaymentInUsd: 1.2315135367772556 flexibleSchedule: '{}' contractDuration: '{}' billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency - billingFrequency: '{}' pricePerPaymentInUsd: 1.2315135367772556 flexibleSchedule: '{}' contractDuration: '{}' billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency properties: customMeters: $ref: '#/components/schemas/AzureMarketplacePriceAndAvailabilityPrivateOfferCustomMeters' recurrentPrice: $ref: '#/components/schemas/AzureMarketplacePriceAndAvailabilityRecurrentPrice' type: object AzureMarketplacePriceAndAvailabilityRecurrentPrice: example: recurrentPriceMode: flatRate userLimits: min: 6.84685269835264 max: 1.4894159098541704 priceInputOption: perMarket prices: - billingFrequency: '{}' pricePerPaymentInUsd: 1.2315135367772556 flexibleSchedule: '{}' contractDuration: '{}' billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency - billingFrequency: '{}' pricePerPaymentInUsd: 1.2315135367772556 flexibleSchedule: '{}' contractDuration: '{}' billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency properties: priceInputOption: description: default "usd" enum: - perMarket - usd type: string prices: items: $ref: '#/components/schemas/AzureMarketplacePriceAndAvailabilityRecurrentPriceItem' type: array recurrentPriceMode: description: default "flatRate" enum: - flatRate - perUser type: string userLimits: $ref: '#/components/schemas/AzureMarketplacePriceAndAvailabilityRecurrentPriceUserLimit' type: object AzureMarketplacePriceAndAvailabilityRecurrentPriceItem: example: billingFrequency: '{}' pricePerPaymentInUsd: 1.2315135367772556 flexibleSchedule: '{}' contractDuration: '{}' billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency properties: billingFrequency: allOf: - $ref: '#/components/schemas/AzureMarketplaceTerm' description: billingFrequency defines the frequency of the billing for recurring price. type: object billingTerm: $ref: '#/components/schemas/AzureMarketplaceTerm' contractDuration: allOf: - $ref: '#/components/schemas/AzureMarketplaceTerm' description: contractDuration defines the duration of the contract, should always be “year” with value 1 or 2 or 3 type: object flexibleSchedule: allOf: - $ref: '#/components/schemas/AzureMarketplacePriceFlexibleSchedule' description: flexibleSchedule defines the payment installments for flexible billing. type: object paymentOption: $ref: '#/components/schemas/AzureMarketplaceTerm' pricePerPaymentInUsd: type: number prices: items: $ref: '#/components/schemas/AzureMarketplacePrice' type: array type: object AzureMarketplacePriceAndAvailabilityRecurrentPriceUserLimit: example: min: 6.84685269835264 max: 1.4894159098541704 properties: max: type: number min: type: number type: object AzureMarketplacePriceAndAvailabilitySoftwareReservation: example: percentageSave: 6.704019297950036 term: 3.353193347011243 type: month properties: percentageSave: description: default 0 type: number term: description: default 0 type: number type: enum: - month - year type: string type: object AzureMarketplacePriceAndAvailabilitySystemMeterPrice: example: price: 5.944895607614016 priceInputOption: perCore prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency properties: price: description: default 0 type: number priceInputOption: enum: - perCore - perEveryCoreInCluster - perNode - perEveryNodeInCluster - perPod - perCluster type: string prices: items: $ref: '#/components/schemas/AzureMarketplacePrice' type: array type: object AzureMarketplacePriceBillingSchedule: properties: chargeDate: description: In format of YYYY-MM-DD. type: string note: type: string pricePerPaymentInUsd: type: number type: object AzureMarketplacePriceFlexibleSchedule: properties: billingSchedule: items: $ref: '#/components/schemas/AzureMarketplacePriceBillingSchedule' type: array initialCharge: $ref: '#/components/schemas/AzureMarketplacePriceInitialCharge' price: type: number type: object AzureMarketplacePriceInitialCharge: properties: note: type: string pricePerPaymentInUsd: type: number type: object AzureMarketplacePrivateOffer: properties: $schema: type: string acceptBy: description: in format YYYY-MM-DD format: date-time type: string acceptanceLinks: items: $ref: '#/components/schemas/AzureMarketplacePrivateOfferAcceptanceLink' type: array beneficiaries: items: $ref: '#/components/schemas/AzureMarketplacePrivateOfferBeneficiary' type: array customerContractRenewal: description: If true, it is a renewal offer for an existing customer. type: boolean eTag: type: string end: description: in format YYYY-MM-DD format: date-time type: string id: description: in format of "private-offer/private-offer-durable-id" type: string lastModified: description: in format YYYY-MM-DD format: date-time type: string name: type: string notificationContacts: description: array of email addresses of the users to be notified of any changes in the private offer status. items: type: string type: array offerPricingType: $ref: '#/components/schemas/AzureMarketplaceOfferPricingType' partners: items: $ref: '#/components/schemas/AzureMarketplacePrivateOfferPartner' type: array preparedBy: type: string pricing: description: Up to 10 pricing entries are allowed. items: $ref: '#/components/schemas/AzureMarketplacePrivateOfferPricing' type: array privateOfferType: $ref: '#/components/schemas/AzureMarketplacePrivateOfferType' resourceName: type: string start: description: in format YYYY-MM-DD, if VariableStartDate = true, this field should be empty. format: date-time type: string state: $ref: '#/components/schemas/AzureMarketplacePrivateOfferState' subState: allOf: - $ref: '#/components/schemas/AzureMarketplacePrivateOfferSubState' type: object termsAndConditionsDocSasUrl: description: Only applicable to private offers with privateOfferType = customerPromotion || cspPromotion type: string termsAndConditionsDocs: description: Only applicable to private offers with privateOfferType = multipartyPromotionOriginator || multipartyPromotionChannelPartner items: $ref: '#/components/schemas/AzureMarketplacePrivateOfferTermsDoc' type: array upgradedFrom: $ref: '#/components/schemas/AzureMarketplacePrivateOfferPromotionReference' validations: items: $ref: '#/components/schemas/AzureMarketplaceValidation' type: array variableStartDate: type: boolean type: object AzureMarketplacePrivateOfferAcceptanceLink: properties: beneficiaryId: description: The Customer Billing Account ID. type: string link: type: string type: object AzureMarketplacePrivateOfferBeneficiary: properties: beneficiaryRecipients: items: $ref: '#/components/schemas/AzureMarketplacePrivateOfferBeneficiaryRecipient' type: array description: type: string id: description: the customer billing account id. type: string type: object AzureMarketplacePrivateOfferBeneficiaryRecipient: properties: id: type: string recipientType: enum: - cspCustomer - billingGroup type: string type: object AzureMarketplacePrivateOfferPartner: properties: id: type: string location: type: string partnerName: type: string type: object AzureMarketplacePrivateOfferPricing: properties: basePlan: description: required for SaasNewCustomizedPlans type: string discountPercentage: description: between 0.01 to 100 type: number discountType: $ref: '#/components/schemas/PrivateOfferDiscountType' markupPercentage: description: between 0.00000001 to 100 type: number newPlanDetails: allOf: - $ref: '#/components/schemas/AzureMarketplacePrivateOfferPricingNewPlanDetails' description: required for SaasNewCustomizedPlans type: object originalPlan: allOf: - $ref: '#/components/schemas/AzureMarketplacePriceAndAvailabilityPrivateOfferPlan' description: the pricing plan of the original plan. type: object plan: description: The base/original/default plan of the private offer, in format of "plan/product-durable-id/plan-durable-id" type: string planId: type: string planName: type: string planType: description: The type of the plan, FLAT_RATE or PER_USER. enum: - FLAT_RATE - PER_USER type: string priceDetails: type: object privateOfferPlan: allOf: - $ref: '#/components/schemas/AzureMarketplacePriceAndAvailabilityPrivateOfferPlan' description: the pricing plan of the private offer type: object product: description: in format of "product/product-durable-id" type: string productName: type: string sugerOfferId: type: string type: object AzureMarketplacePrivateOfferPricingNewPlanDetails: properties: description: type: string id: type: string name: type: string type: object AzureMarketplacePrivateOfferPromotionReference: properties: id: type: string name: type: string type: object AzureMarketplacePrivateOfferState: enum: - draft - live - deleted - withdrawn type: string x-enum-varnames: - AzureMarketplacePrivateOfferState_draft - AzureMarketplacePrivateOfferState_live - AzureMarketplacePrivateOfferState_deleted - AzureMarketplacePrivateOfferState_withdrawn AzureMarketplacePrivateOfferSubState: enum: - pendingAcceptance - accepted - pendingPartnerAction type: string x-enum-varnames: - AzureMarketplacePrivateOfferSubState_pendingAcceptance - AzureMarketplacePrivateOfferSubState_accepted - AzureMarketplacePrivateOfferSubState_pendingPartnerAction AzureMarketplacePrivateOfferTermsDoc: properties: customerFacingDocumentName: type: string fileName: type: string sasUrl: type: string type: object AzureMarketplacePrivateOfferType: enum: - '' - customerPromotion - cspPromotion - multipartyPromotionChannelPartner - multipartyPromotionOriginator type: string x-enum-varnames: - AzureMarketplacePrivateOfferType_unknown - AzureMarketplacePrivateOfferType_customerPromotion - AzureMarketplacePrivateOfferType_cspPromotion - AzureMarketplacePrivateOfferType_multipartyPromotionChannelPartner - AzureMarketplacePrivateOfferType_multipartyPromotionOriginator AzureMarketplaceProduct: example: lifecycleState: null $schema: $schema productGroup: productGroup identity: externalId: externalId alias: alias resourceName: resourceName id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message type: azureApplication properties: $schema: type: string alias: description: The Product Display Name type: string id: description: in format of "product/product-durable-id" type: string identity: $ref: '#/components/schemas/AzureMarketplaceIdentity' lifecycleState: $ref: '#/components/schemas/AzureMarketplaceResourceLifecycleState' productGroup: type: string resourceName: type: string type: $ref: '#/components/schemas/AzureMarketplaceProductType' validations: items: $ref: '#/components/schemas/AzureMarketplaceValidation' type: array type: object AzureMarketplaceProductResource: example: customerLeads: salesforceLeadConfiguration: '{}' product: product $schema: $schema tableLeadConfiguration: '{}' httpsEndpointLeadConfiguration: '{}' resourceName: resourceName emailLeadConfiguration: '{}' dynamicsLeadConfiguration: '{}' marketoLeadConfiguration: '{}' leadDestination: none id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message blobLeadConfiguration: '{}' product: lifecycleState: null $schema: $schema productGroup: productGroup identity: externalId: externalId alias: alias resourceName: resourceName id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message type: azureApplication priceAndAvailabilityOffer: product: product $schema: $schema previewAudiences: - id: id label: label type: none - id: id label: label type: none resourceName: resourceName id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message technicalConfiguration: azureAdTenantId: azureAdTenantId product: product $schema: $schema azureAdAppId: azureAdAppId resourceName: resourceName id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message connectionWebhook: connectionWebhook landingPageUrl: landingPageUrl listingAssets: - lifecycleState: '{}' fileName: fileName product: product $schema: $schema kind: azure displayOrder: 6 languageId: languageId description: description resourceName: resourceName type: azureLogoSmall url: url id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message listing: listing friendlyName: friendlyName - lifecycleState: '{}' fileName: fileName product: product $schema: $schema kind: azure displayOrder: 6 languageId: languageId description: description resourceName: resourceName type: azureLogoSmall url: url id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message listing: listing friendlyName: friendlyName plans: - planListing: summary: summary lifecycleState: null product: product $schema: $schema kind: azureVM-plan languageId: languageId name: name description: description resourceName: resourceName id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message plan: plan priceAndAvailabilityPlan: audience: public product: product softwareReservation: - percentageSave: 6.704019297950036 term: 3.353193347011243 type: month - percentageSave: 6.704019297950036 term: 3.353193347011243 type: month $schema: $schema visibility: visible meterDefine: meterDefine billingTag: billingTag resourceName: resourceName trial: type: day value: 7.386281948385884 markets: - markets - markets privateAudiences: - id: id label: label type: none - id: id label: label type: none id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message plan: plan pricing: customMeters: priceInputOption: perMarket meters: key: pricePerPaymentInUsd: 6.778324963048013 includedQuantities: - quantity: 2.8841621266687802 isInfinite: true billingTerm: type: day value: 7.386281948385884 - quantity: 2.8841621266687802 isInfinite: true billingTerm: type: day value: 7.386281948385884 billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - pricePerPaymentInUsd: 6.878052220127876 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency - pricePerPaymentInUsd: 6.878052220127876 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency licenseModel: byol systemMeterPricing: price: 5.944895607614016 priceInputOption: perCore prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency corePricing: price: 6.965117697638846 priceInputOption: free pricePerCoreSize: '{}' pricePerCore: 1.284659006116532 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency recurrentPrice: recurrentPriceMode: flatRate userLimits: min: 6.84685269835264 max: 1.4894159098541704 priceInputOption: perMarket prices: - billingFrequency: '{}' pricePerPaymentInUsd: 1.2315135367772556 flexibleSchedule: '{}' contractDuration: '{}' billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency - billingFrequency: '{}' pricePerPaymentInUsd: 1.2315135367772556 flexibleSchedule: '{}' contractDuration: '{}' billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency plan: deprecationSchedule: date: date reason: criticalSecurityIssue $schema: $schema alternative: product: '{}' plan: '{}' dateOffset: dateOffset lifecycleState: null product: product displayRank: 3 $schema: $schema azureGovernmentCertifications: - link: link name: name - link: link name: name resourceName: resourceName azureRegions: - azureRegions - azureRegions subtype: managedApplication identity: externalId: externalId alias: alias id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - planListing: summary: summary lifecycleState: null product: product $schema: $schema kind: azureVM-plan languageId: languageId name: name description: description resourceName: resourceName id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message plan: plan priceAndAvailabilityPlan: audience: public product: product softwareReservation: - percentageSave: 6.704019297950036 term: 3.353193347011243 type: month - percentageSave: 6.704019297950036 term: 3.353193347011243 type: month $schema: $schema visibility: visible meterDefine: meterDefine billingTag: billingTag resourceName: resourceName trial: type: day value: 7.386281948385884 markets: - markets - markets privateAudiences: - id: id label: label type: none - id: id label: label type: none id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message plan: plan pricing: customMeters: priceInputOption: perMarket meters: key: pricePerPaymentInUsd: 6.778324963048013 includedQuantities: - quantity: 2.8841621266687802 isInfinite: true billingTerm: type: day value: 7.386281948385884 - quantity: 2.8841621266687802 isInfinite: true billingTerm: type: day value: 7.386281948385884 billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - pricePerPaymentInUsd: 6.878052220127876 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency - pricePerPaymentInUsd: 6.878052220127876 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency licenseModel: byol systemMeterPricing: price: 5.944895607614016 priceInputOption: perCore prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency corePricing: price: 6.965117697638846 priceInputOption: free pricePerCoreSize: '{}' pricePerCore: 1.284659006116532 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency recurrentPrice: recurrentPriceMode: flatRate userLimits: min: 6.84685269835264 max: 1.4894159098541704 priceInputOption: perMarket prices: - billingFrequency: '{}' pricePerPaymentInUsd: 1.2315135367772556 flexibleSchedule: '{}' contractDuration: '{}' billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency - billingFrequency: '{}' pricePerPaymentInUsd: 1.2315135367772556 flexibleSchedule: '{}' contractDuration: '{}' billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency plan: deprecationSchedule: date: date reason: criticalSecurityIssue $schema: $schema alternative: product: '{}' plan: '{}' dateOffset: dateOffset lifecycleState: null product: product displayRank: 3 $schema: $schema azureGovernmentCertifications: - link: link name: name - link: link name: name resourceName: resourceName azureRegions: - azureRegions - azureRegions subtype: managedApplication identity: externalId: externalId alias: alias id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message property: lifecycleState: null appVersion: appVersion product: product $schema: $schema termsConditions: custom kind: azureSaaS resourceName: resourceName customAmendments: - tenants: manualEntries: - description: description id: id - description: description id: id terms: terms - tenants: manualEntries: - description: description id: id - description: description id: id terms: terms cloudIndustries: key: - cloudIndustries - cloudIndustries standardContractAmendment: standardContractAmendment termsOfUseUrl: termsOfUseUrl termsOfUse: termsOfUse industries: key: - industries - industries categories: key: - categories - categories id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message reseller: product: product $schema: $schema resellerChannelState: resellerChannelState audiences: - resourceId: resourceId description: description type: subscription - resourceId: resourceId description: description type: subscription resourceName: resourceName id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message setup: product: product $schema: $schema accessUrl: accessUrl useMicrosoftLicenseManagementService: true sellThroughMicrosoft: true resourceName: resourceName id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message requireLicenseForInstall: true callToAction: free submission: result: succeeded deprecationSchedule: date: date reason: criticalSecurityIssue $schema: $schema alternative: product: '{}' plan: '{}' dateOffset: dateOffset lifecycleState: null product: product $schema: $schema created: created resourceName: resourceName id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message status: notStarted target: targetId: targetId targetType: flight listing: generalLinks: - displayText: displayText link: link - displayText: displayText link: link lifecycleState: '{}' cloudSolutionProviderMarketingMaterials: cloudSolutionProviderMarketingMaterials product: product supportContact: phone: phone name: name email: email url: url governmentSupportWebsite: governmentSupportWebsite $schema: $schema searchKeywords: - searchKeywords - searchKeywords kind: azureSaaS languageId: languageId description: description resourceName: resourceName shortDescription: shortDescription title: title privacyPolicyLink: privacyPolicyLink gettingStartedInstructions: gettingStartedInstructions gloabalSupportWebsite: gloabalSupportWebsite cloudSolutionProviderContact: phone: phone name: name email: email url: url engineeringContact: phone: phone name: name email: email url: url id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message searchResultSummary: searchResultSummary priceAndAvailabilityCustomMeter: product: product $schema: $schema customMeters: key: unitOfMeasure: unitOfMeasure displayName: displayName price: 3.0937452626664474 resourceName: resourceName id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message properties: customerLeads: $ref: '#/components/schemas/AzureMarketplaceCustomerLeads' listing: $ref: '#/components/schemas/AzureMarketplaceListing' listingAssets: items: $ref: '#/components/schemas/AzureMarketplaceListingAsset' type: array plans: items: $ref: '#/components/schemas/AzureMarketplacePlanResource' type: array priceAndAvailabilityCustomMeter: $ref: '#/components/schemas/AzureMarketplacePriceAndAvailabilityCustomMeter' priceAndAvailabilityOffer: $ref: '#/components/schemas/AzureMarketplacePriceAndAvailabilityOffer' product: $ref: '#/components/schemas/AzureMarketplaceProduct' property: $ref: '#/components/schemas/AzureMarketplaceProperty' reseller: $ref: '#/components/schemas/AzureMarketplaceReseller' setup: $ref: '#/components/schemas/AzureCommercialMarketplaceSetup' submission: $ref: '#/components/schemas/AzureMarketplaceSubmission' technicalConfiguration: $ref: '#/components/schemas/AzureMarketplaceSaasTechnicalConfiguration' type: object AzureMarketplaceProductType: enum: - azureApplication - azureContainer - azureVirtualMachine - consultingService - containerApp - coreVirtualMachine - cosellOnly - dynamics365BusinessCentral - dynamics365ForCustomerEngagement - dynamics365ForOperations - iotEdgeModule - managedService - powerBiApp - powerBiVisual - softwareAsAService - xbox360NonBackcompat type: string x-enum-varnames: - AzureMarketplaceProductType_azureApplication - AzureMarketplaceProductType_azureContainer - AzureMarketplaceProductType_azureVirtualMachine - AzureMarketplaceProductType_consultingService - AzureMarketplaceProductType_containerApp - AzureMarketplaceProductType_coreVirtualMachine - AzureMarketplaceProductType_cosellOnly - AzureMarketplaceProductType_dynamics365BusinessCentral - AzureMarketplaceProductType_dynamics365ForCustomerEngagement - AzureMarketplaceProductType_dynamics365ForOperations - AzureMarketplaceProductType_iotEdgeModule - AzureMarketplaceProductType_managedService - AzureMarketplaceProductType_powerBiApp - AzureMarketplaceProductType_powerBiVisual - AzureMarketplaceProductType_softwareAsAService - AzureMarketplaceProductType_xbox360NonBackcompat AzureMarketplaceProperty: example: lifecycleState: null appVersion: appVersion product: product $schema: $schema termsConditions: custom kind: azureSaaS resourceName: resourceName customAmendments: - tenants: manualEntries: - description: description id: id - description: description id: id terms: terms - tenants: manualEntries: - description: description id: id - description: description id: id terms: terms cloudIndustries: key: - cloudIndustries - cloudIndustries standardContractAmendment: standardContractAmendment termsOfUseUrl: termsOfUseUrl termsOfUse: termsOfUse industries: key: - industries - industries categories: key: - categories - categories id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message properties: $schema: type: string appVersion: type: string categories: additionalProperties: items: type: string type: array type: object cloudIndustries: additionalProperties: items: type: string type: array type: object customAmendments: items: $ref: '#/components/schemas/AzureMarketplaceCustomAmendment' type: array id: type: string industries: additionalProperties: items: type: string type: array type: object kind: enum: - azureSaaS - azureVM type: string lifecycleState: $ref: '#/components/schemas/AzureMarketplaceResourceLifecycleState' product: type: string resourceName: type: string standardContractAmendment: type: string termsConditions: enum: - custom - standardMicrosoft type: string termsOfUse: type: string termsOfUseUrl: type: string validations: items: $ref: '#/components/schemas/AzureMarketplaceValidation' type: array type: object AzureMarketplaceReseller: example: product: product $schema: $schema resellerChannelState: resellerChannelState audiences: - resourceId: resourceId description: description type: subscription - resourceId: resourceId description: description type: subscription resourceName: resourceName id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message properties: $schema: type: string audiences: items: $ref: '#/components/schemas/AzureMarketplacePreviewAudience' type: array id: type: string product: type: string resellerChannelState: type: string resourceName: type: string validations: items: $ref: '#/components/schemas/AzureMarketplaceValidation' type: array type: object AzureMarketplaceResourceLifecycleState: enum: - notAvailable - neverUsed - test - preview - generallyAvailable - deprecated - decommissioned - deleted type: string x-enum-varnames: - AzureMarketplaceResourceLifecycleState_NotAvailable - AzureMarketplaceResourceLifecycleState_NeverUsed - AzureMarketplaceResourceLifecycleState_Test - AzureMarketplaceResourceLifecycleState_Preview - AzureMarketplaceResourceLifecycleState_GenerallyAvailable - AzureMarketplaceResourceLifecycleState_Deprecated - AzureMarketplaceResourceLifecycleState_Decommissioned - AzureMarketplaceResourceLifecycleState_Deleted AzureMarketplaceResourceTarget: example: targetId: targetId targetType: flight properties: targetId: type: string targetType: enum: - flight - sandbox - draft - preview - live - certification - retail type: string type: object AzureMarketplaceSaasTechnicalConfiguration: example: azureAdTenantId: azureAdTenantId product: product $schema: $schema azureAdAppId: azureAdAppId resourceName: resourceName id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message connectionWebhook: connectionWebhook landingPageUrl: landingPageUrl properties: $schema: type: string azureAdAppId: description: Azure AD Application Id type: string azureAdTenantId: description: Azure AD Tenant Id type: string connectionWebhook: type: string id: type: string landingPageUrl: type: string product: description: in format of "product/product-durable-id" type: string resourceName: type: string validations: items: $ref: '#/components/schemas/AzureMarketplaceValidation' type: array type: object AzureMarketplaceSubmission: example: result: succeeded deprecationSchedule: date: date reason: criticalSecurityIssue $schema: $schema alternative: product: '{}' plan: '{}' dateOffset: dateOffset lifecycleState: null product: product $schema: $schema created: created resourceName: resourceName id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message status: notStarted target: targetId: targetId targetType: flight properties: $schema: type: string created: description: Date-time string type: string deprecationSchedule: $ref: '#/components/schemas/AzureMarketplaceDeprecationSchedule' id: type: string lifecycleState: $ref: '#/components/schemas/AzureMarketplaceResourceLifecycleState' product: type: string resourceName: type: string result: enum: - succeeded - failed - pending type: string status: enum: - notStarted - running - completed type: string target: $ref: '#/components/schemas/AzureMarketplaceResourceTarget' validations: items: $ref: '#/components/schemas/AzureMarketplaceValidation' type: array type: object AzureMarketplaceSubscription: example: fulfillmentId: fulfillmentId quantity: 1 allowedCustomerOperations: - Read - Read created: 2000-01-23 04:56:07+00:00 purchaser: firstName: firstName lastName: lastName licenseType: licenseType puid: puid customerId: customerId tenantId: tenantId billingAccountId: billingAccountId emailId: emailId objectId: objectId isFreeTrial: true sessionId: sessionId saasSubscriptionStatus: NotStarted publisherId: publisherId beneficiary: firstName: firstName lastName: lastName licenseType: licenseType puid: puid customerId: customerId tenantId: tenantId billingAccountId: billingAccountId emailId: emailId objectId: objectId isTest: true name: name autoRenew: true offerId: offerId planId: planId storeFront: storeFront term: endDate: 2000-01-23 04:56:07+00:00 chargeDuration: chargeDuration startDate: 2000-01-23 04:56:07+00:00 termUnit: termUnit id: id lastModified: lastModified sandboxType: None sessionMode: None properties: allowedCustomerOperations: items: enum: - Read - Update - Delete type: string type: array autoRenew: type: boolean beneficiary: $ref: '#/components/schemas/AzureADIdentifier' created: format: date-time type: string fulfillmentId: type: string id: type: string isFreeTrial: type: boolean isTest: type: boolean lastModified: type: string name: type: string offerId: type: string planId: type: string publisherId: type: string purchaser: $ref: '#/components/schemas/AzureADIdentifier' quantity: type: integer saasSubscriptionStatus: $ref: '#/components/schemas/AzureMarketplaceSubscriptionStatus' sandboxType: enum: - None - Csp type: string sessionId: type: string sessionMode: enum: - None - DryRun type: string storeFront: type: string term: $ref: '#/components/schemas/AzureTerm' type: object AzureMarketplaceSubscriptionStatus: enum: - NotStarted - PendingFulfillmentStart - Subscribed - Suspended - Unsubscribed type: string x-enum-varnames: - AzureMarketplaceSubscriptionStatus_NotStarted - AzureMarketplaceSubscriptionStatus_PendingFulfillmentStart - AzureMarketplaceSubscriptionStatus_Subscribed - AzureMarketplaceSubscriptionStatus_Suspended - AzureMarketplaceSubscriptionStatus_Unsubscribed AzureMarketplaceTerm: example: type: day value: 7.386281948385884 properties: type: enum: - day - week - month - year type: string value: description: default 0 type: number type: object AzureMarketplaceValidation: example: resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message properties: $schema: type: string code: enum: - businessValidationError - collectionLimitExceeded - invalidId - invalidEntityStatus - invalidRequest - invalidResource - invalidState - notDeployed - notSupported - operationCanceled - productLocked - resourceNotFound - schemaValidationError type: string level: enum: - informational - warning type: string message: type: string resourceId: type: string type: object AzureMarketplaceVmPrice: example: patternProperties: key: quantity: 7.457744773683766 unitPricePerPaymentPeriodInUsd: 1.1730742509559433 properties: patternProperties: additionalProperties: $ref: '#/components/schemas/AzureMarketplaceVmPricePropertyItem' type: object type: object AzureMarketplaceVmPricePropertyItem: example: quantity: 7.457744773683766 unitPricePerPaymentPeriodInUsd: 1.1730742509559433 properties: quantity: type: number unitPricePerPaymentPeriodInUsd: type: number type: object AzurePendingUpdateInfo: example: status: status updateType: updateType properties: status: type: string updateType: type: string type: object AzurePrice: example: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode properties: currencyCode: description: ISO currency code, Three characters type: string openPrice: type: number priceTierID: type: string type: object AzurePriceCadence: example: type: Month value: 9 properties: type: enum: - Month - Year type: string value: type: integer type: object AzurePriceSchedule: example: pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode properties: priceCadence: $ref: '#/components/schemas/AzurePriceCadence' pricingModel: enum: - Flat - Recurring - Usage type: string pricingUnits: items: $ref: '#/components/schemas/AzurePricingUnit' type: array retailPrice: $ref: '#/components/schemas/AzurePrice' type: object AzurePricingUnit: example: unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true properties: isUnlimitedUnit: type: boolean lowerUnit: type: integer name: enum: - sharedcore - transactions type: string unitType: type: string upperUnit: type: integer type: object AzureProduct: example: availabilities: - visibility: visibility enterpriseLicensing: enterpriseLicensing emailAudiences: - description: description id: id - description: description id: id subscriptionAudiences: - description: description id: id - description: description id: id id: id resourceType: resourceType - visibility: visibility enterpriseLicensing: enterpriseLicensing emailAudiences: - description: description id: id - description: description id: id subscriptionAudiences: - description: description id: id - description: description id: id id: id resourceType: resourceType externalIDs: - type: type value: value - type: type value: value variants: - conversionPaths: conversionPaths leadGenID: leadGenID extendedProperties: - type: type value: value - type: type value: value cloudAvailabilities: - cloudAvailabilities - cloudAvailabilities azureGovernmentCertifications: - validationResults: - errorMessage: errorMessage memberNames: - memberNames - memberNames - errorMessage: errorMessage memberNames: - memberNames - memberNames title: title uri: uri - validationResults: - errorMessage: errorMessage memberNames: - memberNames - memberNames - errorMessage: errorMessage memberNames: - memberNames - memberNames title: title uri: uri externalID: externalID referenceVariantID: referenceVariantID id: id state: InActive featureAvailabilities: - markets: - marketCode: marketCode friendlyName: friendlyName - marketCode: marketCode friendlyName: friendlyName visibility: Public priceSchedules: - isBaseSchedule: true schedules: - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true marketCodes: - marketCodes - marketCodes friendlyName: friendlyName - isBaseSchedule: true schedules: - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true marketCodes: - marketCodes - marketCodes friendlyName: friendlyName customMeters: - unitOfMeasure: unitOfMeasure displayName: displayName includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly isEnabled: true priceInUsd: 5.025004791520295 id: id uniqueID: uniqueID - unitOfMeasure: unitOfMeasure displayName: displayName includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly isEnabled: true priceInUsd: 5.025004791520295 id: id uniqueID: uniqueID marketStates: - marketCode: marketCode state: Disabled - marketCode: marketCode state: Disabled tenantAudiences: - description: description id: id - description: description id: id subscriptionAudiences: - description: description id: id - description: description id: id id: id properties: - type: type value: value - type: type value: value trial: duration: 9 dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true type: NoTrial durationType: Minute isHidden: true resourceType: resourceType - markets: - marketCode: marketCode friendlyName: friendlyName - marketCode: marketCode friendlyName: friendlyName visibility: Public priceSchedules: - isBaseSchedule: true schedules: - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true marketCodes: - marketCodes - marketCodes friendlyName: friendlyName - isBaseSchedule: true schedules: - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true marketCodes: - marketCodes - marketCodes friendlyName: friendlyName customMeters: - unitOfMeasure: unitOfMeasure displayName: displayName includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly isEnabled: true priceInUsd: 5.025004791520295 id: id uniqueID: uniqueID - unitOfMeasure: unitOfMeasure displayName: displayName includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly isEnabled: true priceInUsd: 5.025004791520295 id: id uniqueID: uniqueID marketStates: - marketCode: marketCode state: Disabled - marketCode: marketCode state: Disabled tenantAudiences: - description: description id: id - description: description id: id subscriptionAudiences: - description: description id: id - description: description id: id id: id properties: - type: type value: value - type: type value: value trial: duration: 9 dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true type: NoTrial durationType: Minute isHidden: true resourceType: resourceType friendlyName: friendlyName resourceType: AzureSkuVariant - conversionPaths: conversionPaths leadGenID: leadGenID extendedProperties: - type: type value: value - type: type value: value cloudAvailabilities: - cloudAvailabilities - cloudAvailabilities azureGovernmentCertifications: - validationResults: - errorMessage: errorMessage memberNames: - memberNames - memberNames - errorMessage: errorMessage memberNames: - memberNames - memberNames title: title uri: uri - validationResults: - errorMessage: errorMessage memberNames: - memberNames - memberNames - errorMessage: errorMessage memberNames: - memberNames - memberNames title: title uri: uri externalID: externalID referenceVariantID: referenceVariantID id: id state: InActive featureAvailabilities: - markets: - marketCode: marketCode friendlyName: friendlyName - marketCode: marketCode friendlyName: friendlyName visibility: Public priceSchedules: - isBaseSchedule: true schedules: - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true marketCodes: - marketCodes - marketCodes friendlyName: friendlyName - isBaseSchedule: true schedules: - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true marketCodes: - marketCodes - marketCodes friendlyName: friendlyName customMeters: - unitOfMeasure: unitOfMeasure displayName: displayName includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly isEnabled: true priceInUsd: 5.025004791520295 id: id uniqueID: uniqueID - unitOfMeasure: unitOfMeasure displayName: displayName includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly isEnabled: true priceInUsd: 5.025004791520295 id: id uniqueID: uniqueID marketStates: - marketCode: marketCode state: Disabled - marketCode: marketCode state: Disabled tenantAudiences: - description: description id: id - description: description id: id subscriptionAudiences: - description: description id: id - description: description id: id id: id properties: - type: type value: value - type: type value: value trial: duration: 9 dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true type: NoTrial durationType: Minute isHidden: true resourceType: resourceType - markets: - marketCode: marketCode friendlyName: friendlyName - marketCode: marketCode friendlyName: friendlyName visibility: Public priceSchedules: - isBaseSchedule: true schedules: - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true marketCodes: - marketCodes - marketCodes friendlyName: friendlyName - isBaseSchedule: true schedules: - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true marketCodes: - marketCodes - marketCodes friendlyName: friendlyName customMeters: - unitOfMeasure: unitOfMeasure displayName: displayName includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly isEnabled: true priceInUsd: 5.025004791520295 id: id uniqueID: uniqueID - unitOfMeasure: unitOfMeasure displayName: displayName includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly isEnabled: true priceInUsd: 5.025004791520295 id: id uniqueID: uniqueID marketStates: - marketCode: marketCode state: Disabled - marketCode: marketCode state: Disabled tenantAudiences: - description: description id: id - description: description id: id subscriptionAudiences: - description: description id: id - description: description id: id id: id properties: - type: type value: value - type: type value: value trial: duration: 9 dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true type: NoTrial durationType: Minute isHidden: true resourceType: resourceType friendlyName: friendlyName resourceType: AzureSkuVariant branches: - module: module id: id variantID: variantID currentDraftInstanceID: currentDraftInstanceID type: type friendlyName: friendlyName resourceType: resourceType - module: module id: id variantID: variantID currentDraftInstanceID: currentDraftInstanceID type: type friendlyName: friendlyName resourceType: resourceType isModularPublishing: true listings: - summary: summary accessInformation: accessInformation keywords: - keywords - keywords compatibleProducts: - compatibleProducts - compatibleProducts description: description shortDescription: shortDescription languageCode: languageCode title: title gettingStartedInstructions: gettingStartedInstructions assets: - fileName: fileName fileSasUri: fileSasUri description: description id: id state: PendingUpload type: type publisherDefinedSasUri: publisherDefinedSasUri friendlyName: friendlyName order: 4 resourceType: ListingAsset - fileName: fileName fileSasUri: fileSasUri description: description id: id state: PendingUpload type: type publisherDefinedSasUri: publisherDefinedSasUri friendlyName: friendlyName order: 4 resourceType: ListingAsset listingUris: - displayText: displayText subtype: subtype type: type uri: uri - displayText: displayText subtype: subtype type: type uri: uri publisherName: publisherName productDisplayName: productDisplayName listingContacts: - phone: phone name: name type: CustomerSupport uri: uri email: email - phone: phone name: name type: CustomerSupport uri: uri email: email id: id resourceType: AzureListing - summary: summary accessInformation: accessInformation keywords: - keywords - keywords compatibleProducts: - compatibleProducts - compatibleProducts description: description shortDescription: shortDescription languageCode: languageCode title: title gettingStartedInstructions: gettingStartedInstructions assets: - fileName: fileName fileSasUri: fileSasUri description: description id: id state: PendingUpload type: type publisherDefinedSasUri: publisherDefinedSasUri friendlyName: friendlyName order: 4 resourceType: ListingAsset - fileName: fileName fileSasUri: fileSasUri description: description id: id state: PendingUpload type: type publisherDefinedSasUri: publisherDefinedSasUri friendlyName: friendlyName order: 4 resourceType: ListingAsset listingUris: - displayText: displayText subtype: subtype type: type uri: uri - displayText: displayText subtype: subtype type: type uri: uri publisherName: publisherName productDisplayName: productDisplayName listingContacts: - phone: phone name: name type: CustomerSupport uri: uri email: email - phone: phone name: name type: CustomerSupport uri: uri email: email id: id resourceType: AzureListing plans: - lifecycleState: notAvailable product: product softwareReservation: paymentSchedule: type: day value: 7.386281948385884 reservationDuration: type: day value: 7.386281948385884 vmPrices: patternProperties: key: quantity: 7.457744773683766 unitPricePerPaymentPeriodInUsd: 1.1730742509559433 $schema: $schema offerPricingType: '{}' visibility: visible planName: planName resourceName: resourceName id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message plan: plan pricing: customMeters: priceInputOption: perMarket meters: '{}' recurrentPrice: recurrentPriceMode: flatRate userLimits: min: 6.84685269835264 max: 1.4894159098541704 priceInputOption: perMarket prices: - billingFrequency: '{}' pricePerPaymentInUsd: 1.2315135367772556 flexibleSchedule: '{}' contractDuration: '{}' billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency - billingFrequency: '{}' pricePerPaymentInUsd: 1.2315135367772556 flexibleSchedule: '{}' contractDuration: '{}' billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency - lifecycleState: notAvailable product: product softwareReservation: paymentSchedule: type: day value: 7.386281948385884 reservationDuration: type: day value: 7.386281948385884 vmPrices: patternProperties: key: quantity: 7.457744773683766 unitPricePerPaymentPeriodInUsd: 1.1730742509559433 $schema: $schema offerPricingType: '{}' visibility: visible planName: planName resourceName: resourceName id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message plan: plan pricing: customMeters: priceInputOption: perMarket meters: '{}' recurrentPrice: recurrentPriceMode: flatRate userLimits: min: 6.84685269835264 max: 1.4894159098541704 priceInputOption: perMarket prices: - billingFrequency: '{}' pricePerPaymentInUsd: 1.2315135367772556 flexibleSchedule: '{}' contractDuration: '{}' billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency - billingFrequency: '{}' pricePerPaymentInUsd: 1.2315135367772556 flexibleSchedule: '{}' contractDuration: '{}' billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency submissions: - subState: InDraft pendingUpdateInfo: status: status updateType: updateType resources: - type: type value: value - type: type value: value areResourcesReady: true id: id publishedTimeInUtc: 2000-01-23 04:56:07+00:00 state: Inprogress variantResources: - resources: - type: type value: value - type: type value: value variantID: variantID - resources: - type: type value: value - type: type value: value variantID: variantID releaseNumber: 4 targets: - type: type value: value - type: type value: value friendlyName: friendlyName resourceType: Submission - subState: InDraft pendingUpdateInfo: status: status updateType: updateType resources: - type: type value: value - type: type value: value areResourcesReady: true id: id publishedTimeInUtc: 2000-01-23 04:56:07+00:00 state: Inprogress variantResources: - resources: - type: type value: value - type: type value: value variantID: variantID - resources: - type: type value: value - type: type value: value variantID: variantID releaseNumber: 4 targets: - type: type value: value - type: type value: value friendlyName: friendlyName resourceType: Submission name: name packageConfigurations: - landingPageUri: landingPageUri azureActiveDirectoryApplicationID: azureActiveDirectoryApplicationID id: id azureActiveDirectoryTenantID: azureActiveDirectoryTenantID connectionWebhook: connectionWebhook resourceType: AzureSoftwareAsAServicePackageConfiguration - landingPageUri: landingPageUri azureActiveDirectoryApplicationID: azureActiveDirectoryApplicationID id: id azureActiveDirectoryTenantID: azureActiveDirectoryTenantID connectionWebhook: connectionWebhook resourceType: AzureSoftwareAsAServicePackageConfiguration setup: '{}' id: id properties: - appVersion: appVersion useEnterpriseContract: true submissionVersion: submissionVersion customAmendments: - customAmendments - customAmendments extendedProperties: - extendedProperties - extendedProperties termsOfUse: termsOfUse hideKeys: - hideKeys - hideKeys leveledIndustries: key: '' marketingOnlyChange: true globalAmendmentTerms: globalAmendmentTerms industries: - industries - industries additionalCategories: - additionalCategories - additionalCategories applicableProducts: - applicableProducts - applicableProducts leveledCategories: key: '' categories: - categories - categories id: id productTags: - productTags - productTags resourceType: resourceType - appVersion: appVersion useEnterpriseContract: true submissionVersion: submissionVersion customAmendments: - customAmendments - customAmendments extendedProperties: - extendedProperties - extendedProperties termsOfUse: termsOfUse hideKeys: - hideKeys - hideKeys leveledIndustries: key: '' marketingOnlyChange: true globalAmendmentTerms: globalAmendmentTerms industries: - industries - industries additionalCategories: - additionalCategories - additionalCategories applicableProducts: - applicableProducts - applicableProducts leveledCategories: key: '' categories: - categories - categories id: id productTags: - productTags - productTags resourceType: resourceType resourceType: resourceType properties: availabilities: items: $ref: '#/components/schemas/AzureProductAvailability' type: array branches: items: $ref: '#/components/schemas/AzureProductBranch' type: array externalIDs: items: $ref: '#/components/schemas/AzureTypeValue' type: array id: type: string isModularPublishing: type: boolean listings: items: $ref: '#/components/schemas/AzureProductListing' type: array name: type: string packageConfigurations: items: $ref: '#/components/schemas/AzureProductPackageConfiguration' type: array plans: description: All plans under this product items: $ref: '#/components/schemas/AzureMarketplacePriceAndAvailabilityPrivateOfferPlan' type: array properties: items: $ref: '#/components/schemas/AzureProductProperty' type: array resourceType: type: string setup: allOf: - $ref: '#/components/schemas/AzureProductSetup' description: Not original fields. They are populated by other API calls type: object submissions: items: $ref: '#/components/schemas/AzureProductSubmission' type: array variants: items: $ref: '#/components/schemas/AzureProductVariant' type: array type: object AzureProductAvailability: example: visibility: visibility enterpriseLicensing: enterpriseLicensing emailAudiences: - description: description id: id - description: description id: id subscriptionAudiences: - description: description id: id - description: description id: id id: id resourceType: resourceType properties: emailAudiences: items: $ref: '#/components/schemas/AzureAudience' type: array enterpriseLicensing: type: string id: type: string resourceType: type: string subscriptionAudiences: items: $ref: '#/components/schemas/AzureAudience' type: array visibility: type: string type: object AzureProductBranch: example: module: module id: id variantID: variantID currentDraftInstanceID: currentDraftInstanceID type: type friendlyName: friendlyName resourceType: resourceType properties: currentDraftInstanceID: type: string friendlyName: type: string id: type: string module: type: string resourceType: type: string type: type: string variantID: type: string type: object AzureProductFeatureAvailability: example: markets: - marketCode: marketCode friendlyName: friendlyName - marketCode: marketCode friendlyName: friendlyName visibility: Public priceSchedules: - isBaseSchedule: true schedules: - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true marketCodes: - marketCodes - marketCodes friendlyName: friendlyName - isBaseSchedule: true schedules: - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true marketCodes: - marketCodes - marketCodes friendlyName: friendlyName customMeters: - unitOfMeasure: unitOfMeasure displayName: displayName includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly isEnabled: true priceInUsd: 5.025004791520295 id: id uniqueID: uniqueID - unitOfMeasure: unitOfMeasure displayName: displayName includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly isEnabled: true priceInUsd: 5.025004791520295 id: id uniqueID: uniqueID marketStates: - marketCode: marketCode state: Disabled - marketCode: marketCode state: Disabled tenantAudiences: - description: description id: id - description: description id: id subscriptionAudiences: - description: description id: id - description: description id: id id: id properties: - type: type value: value - type: type value: value trial: duration: 9 dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true type: NoTrial durationType: Minute isHidden: true resourceType: resourceType properties: customMeters: items: $ref: '#/components/schemas/AzureProductVariantCustomMeter' type: array id: type: string isHidden: type: boolean marketStates: items: $ref: '#/components/schemas/AzureMarketState' type: array markets: items: $ref: '#/components/schemas/AzureMarket' type: array priceSchedules: items: $ref: '#/components/schemas/AzureProductVariantPriceSchedule' type: array properties: items: $ref: '#/components/schemas/AzureTypeValue' type: array resourceType: description: ResourceType = FeatureAvailability type: string subscriptionAudiences: items: $ref: '#/components/schemas/AzureAudience' type: array tenantAudiences: items: $ref: '#/components/schemas/AzureAudience' type: array trial: $ref: '#/components/schemas/AzureProductVariantTrial' visibility: enum: - Public - Private type: string type: object AzureProductListing: example: summary: summary accessInformation: accessInformation keywords: - keywords - keywords compatibleProducts: - compatibleProducts - compatibleProducts description: description shortDescription: shortDescription languageCode: languageCode title: title gettingStartedInstructions: gettingStartedInstructions assets: - fileName: fileName fileSasUri: fileSasUri description: description id: id state: PendingUpload type: type publisherDefinedSasUri: publisherDefinedSasUri friendlyName: friendlyName order: 4 resourceType: ListingAsset - fileName: fileName fileSasUri: fileSasUri description: description id: id state: PendingUpload type: type publisherDefinedSasUri: publisherDefinedSasUri friendlyName: friendlyName order: 4 resourceType: ListingAsset listingUris: - displayText: displayText subtype: subtype type: type uri: uri - displayText: displayText subtype: subtype type: type uri: uri publisherName: publisherName productDisplayName: productDisplayName listingContacts: - phone: phone name: name type: CustomerSupport uri: uri email: email - phone: phone name: name type: CustomerSupport uri: uri email: email id: id resourceType: AzureListing properties: accessInformation: type: string assets: description: Not original fields. They are populated by other API calls items: $ref: '#/components/schemas/AzureProductListingAsset' type: array compatibleProducts: items: type: string type: array description: type: string gettingStartedInstructions: type: string id: type: string keywords: items: type: string type: array languageCode: type: string listingContacts: items: $ref: '#/components/schemas/AzureListingContact' type: array listingUris: items: $ref: '#/components/schemas/AzureListingUri' type: array productDisplayName: type: string publisherName: type: string resourceType: enum: - AzureListing type: string shortDescription: type: string summary: type: string title: type: string type: object AzureProductListingAsset: example: fileName: fileName fileSasUri: fileSasUri description: description id: id state: PendingUpload type: type publisherDefinedSasUri: publisherDefinedSasUri friendlyName: friendlyName order: 4 resourceType: ListingAsset properties: description: type: string fileName: type: string fileSasUri: type: string friendlyName: type: string id: type: string order: type: integer publisherDefinedSasUri: type: string resourceType: enum: - ListingAsset - ListingImage - ListingVideo type: string state: enum: - PendingUpload - Uploaded - InProcessing - Processed - ProcessFailed type: string type: type: string type: object AzureProductPackageConfiguration: example: landingPageUri: landingPageUri azureActiveDirectoryApplicationID: azureActiveDirectoryApplicationID id: id azureActiveDirectoryTenantID: azureActiveDirectoryTenantID connectionWebhook: connectionWebhook resourceType: AzureSoftwareAsAServicePackageConfiguration properties: azureActiveDirectoryApplicationID: type: string azureActiveDirectoryTenantID: type: string connectionWebhook: type: string id: type: string landingPageUri: type: string resourceType: enum: - AzureSoftwareAsAServicePackageConfiguration type: string type: object AzureProductProperty: example: appVersion: appVersion useEnterpriseContract: true submissionVersion: submissionVersion customAmendments: - customAmendments - customAmendments extendedProperties: - extendedProperties - extendedProperties termsOfUse: termsOfUse hideKeys: - hideKeys - hideKeys leveledIndustries: key: '' marketingOnlyChange: true globalAmendmentTerms: globalAmendmentTerms industries: - industries - industries additionalCategories: - additionalCategories - additionalCategories applicableProducts: - applicableProducts - applicableProducts leveledCategories: key: '' categories: - categories - categories id: id productTags: - productTags - productTags resourceType: resourceType properties: additionalCategories: items: type: string type: array appVersion: type: string applicableProducts: items: type: string type: array categories: items: type: string type: array customAmendments: items: type: string type: array extendedProperties: items: type: string type: array globalAmendmentTerms: type: string hideKeys: items: type: string type: array id: type: string industries: items: type: string type: array leveledCategories: additionalProperties: true type: object leveledIndustries: additionalProperties: true type: object marketingOnlyChange: type: boolean productTags: items: type: string type: array resourceType: type: string submissionVersion: type: string termsOfUse: type: string useEnterpriseContract: type: boolean type: object AzureProductSetup: properties: callToAction: enum: - free - free-trial - contact-me type: string channelStates: items: $ref: '#/components/schemas/AzureTypeValue' type: array enableTestDrive: type: boolean resourceType: enum: - AzureProductSetup type: string sellingOption: enum: - ListingOnly - ListAndSell type: string testDriveType: type: string trialUri: type: string type: object AzureProductSubmission: example: subState: InDraft pendingUpdateInfo: status: status updateType: updateType resources: - type: type value: value - type: type value: value areResourcesReady: true id: id publishedTimeInUtc: 2000-01-23 04:56:07+00:00 state: Inprogress variantResources: - resources: - type: type value: value - type: type value: value variantID: variantID - resources: - type: type value: value - type: type value: value variantID: variantID releaseNumber: 4 targets: - type: type value: value - type: type value: value friendlyName: friendlyName resourceType: Submission properties: areResourcesReady: type: boolean friendlyName: type: string id: type: string pendingUpdateInfo: $ref: '#/components/schemas/AzurePendingUpdateInfo' publishedTimeInUtc: format: date-time type: string releaseNumber: type: integer resourceType: enum: - Submission type: string resources: items: $ref: '#/components/schemas/AzureTypeValue' type: array state: enum: - Inprogress - Published type: string subState: enum: - InDraft - Submitted - Failed - FailedInCertification - ReadyToPublish - Publishing - Published - InStore type: string targets: items: $ref: '#/components/schemas/AzureTypeValue' type: array variantResources: items: $ref: '#/components/schemas/AzureVariantResource' type: array type: object AzureProductVariant: example: conversionPaths: conversionPaths leadGenID: leadGenID extendedProperties: - type: type value: value - type: type value: value cloudAvailabilities: - cloudAvailabilities - cloudAvailabilities azureGovernmentCertifications: - validationResults: - errorMessage: errorMessage memberNames: - memberNames - memberNames - errorMessage: errorMessage memberNames: - memberNames - memberNames title: title uri: uri - validationResults: - errorMessage: errorMessage memberNames: - memberNames - memberNames - errorMessage: errorMessage memberNames: - memberNames - memberNames title: title uri: uri externalID: externalID referenceVariantID: referenceVariantID id: id state: InActive featureAvailabilities: - markets: - marketCode: marketCode friendlyName: friendlyName - marketCode: marketCode friendlyName: friendlyName visibility: Public priceSchedules: - isBaseSchedule: true schedules: - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true marketCodes: - marketCodes - marketCodes friendlyName: friendlyName - isBaseSchedule: true schedules: - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true marketCodes: - marketCodes - marketCodes friendlyName: friendlyName customMeters: - unitOfMeasure: unitOfMeasure displayName: displayName includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly isEnabled: true priceInUsd: 5.025004791520295 id: id uniqueID: uniqueID - unitOfMeasure: unitOfMeasure displayName: displayName includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly isEnabled: true priceInUsd: 5.025004791520295 id: id uniqueID: uniqueID marketStates: - marketCode: marketCode state: Disabled - marketCode: marketCode state: Disabled tenantAudiences: - description: description id: id - description: description id: id subscriptionAudiences: - description: description id: id - description: description id: id id: id properties: - type: type value: value - type: type value: value trial: duration: 9 dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true type: NoTrial durationType: Minute isHidden: true resourceType: resourceType - markets: - marketCode: marketCode friendlyName: friendlyName - marketCode: marketCode friendlyName: friendlyName visibility: Public priceSchedules: - isBaseSchedule: true schedules: - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true marketCodes: - marketCodes - marketCodes friendlyName: friendlyName - isBaseSchedule: true schedules: - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true marketCodes: - marketCodes - marketCodes friendlyName: friendlyName customMeters: - unitOfMeasure: unitOfMeasure displayName: displayName includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly isEnabled: true priceInUsd: 5.025004791520295 id: id uniqueID: uniqueID - unitOfMeasure: unitOfMeasure displayName: displayName includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly isEnabled: true priceInUsd: 5.025004791520295 id: id uniqueID: uniqueID marketStates: - marketCode: marketCode state: Disabled - marketCode: marketCode state: Disabled tenantAudiences: - description: description id: id - description: description id: id subscriptionAudiences: - description: description id: id - description: description id: id id: id properties: - type: type value: value - type: type value: value trial: duration: 9 dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true type: NoTrial durationType: Minute isHidden: true resourceType: resourceType friendlyName: friendlyName resourceType: AzureSkuVariant properties: azureGovernmentCertifications: items: $ref: '#/components/schemas/AzureGovernmentCertification' type: array cloudAvailabilities: items: type: string type: array conversionPaths: type: string extendedProperties: items: $ref: '#/components/schemas/AzureTypeValue' type: array externalID: type: string featureAvailabilities: description: Not original fields. They are populated by other API calls items: $ref: '#/components/schemas/AzureProductFeatureAvailability' type: array friendlyName: type: string id: type: string leadGenID: type: string referenceVariantID: type: string resourceType: enum: - AzureSkuVariant - AzureTestDriveVariant type: string state: enum: - InActive - Active type: string type: object AzureProductVariantCustomMeter: example: unitOfMeasure: unitOfMeasure displayName: displayName includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly isEnabled: true priceInUsd: 5.025004791520295 id: id uniqueID: uniqueID properties: displayName: type: string id: type: string includedBaseQuantities: items: $ref: '#/components/schemas/AzureIncludedBaseQuantity' type: array isEnabled: type: boolean priceInUsd: type: number uniqueID: type: string unitOfMeasure: type: string type: object AzureProductVariantPriceSchedule: example: isBaseSchedule: true schedules: - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true marketCodes: - marketCodes - marketCodes friendlyName: friendlyName properties: dateTimeRange: $ref: '#/components/schemas/AzureLocalizedTimeRange' friendlyName: type: string isBaseSchedule: description: There is only one base schedule. type: boolean marketCodes: description: ISO country code items: type: string type: array schedules: items: $ref: '#/components/schemas/AzurePriceSchedule' type: array type: object AzureProductVariantTrial: example: duration: 9 dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true type: NoTrial durationType: Minute properties: dateTimeRange: $ref: '#/components/schemas/AzureLocalizedTimeRange' duration: type: integer durationType: enum: - Minute - Days - Months type: string type: enum: - NoTrial - TimedAccess - TimedUsage - Unlimited type: string type: object AzureTerm: example: endDate: 2000-01-23 04:56:07+00:00 chargeDuration: chargeDuration startDate: 2000-01-23 04:56:07+00:00 termUnit: termUnit properties: chargeDuration: type: string endDate: format: date-time type: string startDate: format: date-time type: string termUnit: type: string type: object AzureTypeValue: example: type: type value: value properties: type: type: string value: type: string type: object AzureValidationResult: example: errorMessage: errorMessage memberNames: - memberNames - memberNames properties: errorMessage: type: string memberNames: items: type: string type: array type: object AzureVariantResource: example: resources: - type: type value: value - type: type value: value variantID: variantID properties: resources: items: $ref: '#/components/schemas/AzureTypeValue' type: array variantID: type: string type: object BillableDimension: example: priceModelTiered: '{}' priceModelTieredPercentage: '{}' priceModelMatrix: '{}' minimumCommit: 5.962133916683182 length: 1 priceModelBulk: '{}' description: description discount: '{}' minimumCommitScope: '{}' minimumCommitProrata: true billableMetricId: billableMetricId priceModelPercentage: '{}' name: name priceModelBasic: '{}' category: '{}' priceModelVolume: '{}' timeUnit: '{}' properties: billableMetricId: description: The ID for the billable metric. type: string category: allOf: - $ref: '#/components/schemas/PriceModelCategory' description: The category of the pricing model. This is used to determine which pricing model to use. type: object description: description: Description of the dimension. This is used in the UI to display the dimension. type: string discount: allOf: - $ref: '#/components/schemas/BillingDiscount' description: Discount for the dimension. type: object length: description: The term length for the commit amount. Applicable to Direct only. type: integer minimumCommit: description: The minimum commit amount. Applicable to Direct only. Ignored if the value is 0 or less. type: number minimumCommitProrata: description: 'If the minimum commit is appled with pro-rata. Applicable to Direct only. If true, the minimum commit amount will be prorated based on the usage period (starting time and ending time).' type: boolean minimumCommitScope: allOf: - $ref: '#/components/schemas/BillingMinimumCommitScope' description: The minimum commit scope. The default value is "DIMENSION" if not set. type: object name: description: Display name of the dimension. This is used in the UI to display the dimension. type: string priceModelBasic: allOf: - $ref: '#/components/schemas/PriceModelBasic' description: The configuration for the Basic pricing model. Applicable to Direct only. type: object priceModelBulk: allOf: - $ref: '#/components/schemas/PriceModelBulk' description: The configuration for the Package pricing model. Applicable to Direct only. type: object priceModelMatrix: allOf: - $ref: '#/components/schemas/PriceModelMatrix' description: The configuration for the Matrix pricing model. Applicable to Direct only. type: object priceModelPercentage: allOf: - $ref: '#/components/schemas/PriceModelPercentage' description: The configuration for the Percentage pricing model. Applicable to Direct only. type: object priceModelTiered: allOf: - $ref: '#/components/schemas/PriceModelTiered' description: The configuration for the Tiered pricing model. Applicable to Direct only. type: object priceModelTieredPercentage: allOf: - $ref: '#/components/schemas/PriceModelTieredPercentage' description: The configuration for the Tiered Percentage pricing model. Applicable to Direct only. type: object priceModelVolume: allOf: - $ref: '#/components/schemas/PriceModelVolume' description: The configuration for the Bulk pricing model. Applicable to Direct only. type: object timeUnit: allOf: - $ref: '#/components/schemas/TimeUnit' description: The term unit for the commit amount. Applicable to Direct only. type: object type: object BillableDimensionFeeDetail: example: feeExpressions: feeExpressions descriptions: descriptions properties: descriptions: description: 'Description of the pricing model that is used to show what the amount is for. like ''Bulk pricing: 0-100 units'', ''Tiered pricing: 0-100 units''' type: string feeExpressions: description: FeeExpression is the expression used to calculate the fee that is used to show how the amount is calculated. like '211 × $0.03' type: string type: object BillableDimensionPriceModelDetail: example: discountExpression: discountExpression amount: 5.637376656633329 quantity: 7.061401241503109 minimumCommit: 2.3021358869347655 name: name discount: '{}' details: - feeExpressions: feeExpressions descriptions: descriptions - feeExpressions: feeExpressions descriptions: descriptions billableMetricKey: '{}' category: '{}' isTrial: true minimumCommitScope: '{}' properties: amount: description: Amount is the amount that is calculated based on the FeeExpression type: number billableMetricKey: allOf: - $ref: '#/components/schemas/MeteringUsageRecordGroupByKey' description: BillableMetricKey is the key of the billable metric type: object category: allOf: - $ref: '#/components/schemas/PriceModelCategory' description: Category of this billable dimension. type: object details: description: Details is the details of the pricing model that is used to show what the amount is for. items: $ref: '#/components/schemas/BillableDimensionFeeDetail' type: array discount: allOf: - $ref: '#/components/schemas/BillingDiscount' description: The discount of this billable dimension if applicable. type: object discountExpression: description: DiscountExpression is the expression used to calculate the discount that is used to show how the discount is calculated. type: string isTrial: description: Flag to indicate if this period is a trial period. type: boolean minimumCommit: description: 'MinimumCommit is the minimum commit amount that is used to show the minimum commit amount. Will be ignored if the value is 0 or less.' type: number minimumCommitScope: allOf: - $ref: '#/components/schemas/BillingMinimumCommitScope' description: The minimum commit scope. The default value is "DIMENSION" if not set. type: object name: description: Name of this billable dimension. type: string quantity: description: 'Final quantity of the billable dimension in the invoice period, which calculates the fee in price model. It may be the sum value of count/sum/unique_count or latest/max value according to different aggregation type.' type: number type: object BillableDimensionUsageDailyRevenue: example: date: date uniquePropertyItems: key: '' quantity: 5.025004791520295 billableMetricKey: groupBysExpression: groupBysExpression id: id properties: billableMetricKey: $ref: '#/components/schemas/MeteringUsageRecordGroupByKey' date: type: string quantity: type: number uniquePropertyItems: additionalProperties: true type: object type: object BillableMetric: example: organizationId: organizationId aggregationType: COUNT creationTime: 2000-01-23 04:56:07+00:00 name: name description: description id: id info: groupBys: - groupBys - groupBys propertyUniqueOn: propertyUniqueOn filterGroups: - filters: - valueType: STRING name: name operation: IS value: '{}' - valueType: STRING name: name operation: IS value: '{}' - filters: - valueType: STRING name: name operation: IS value: '{}' - valueType: STRING name: name operation: IS value: '{}' lastUpdateTime: 2000-01-23 04:56:07+00:00 status: ACTIVE properties: aggregationType: $ref: '#/components/schemas/BillableMetricAggregationType' creationTime: format: date-time type: string description: maxLength: 300 type: string id: maxLength: 36 type: string info: $ref: '#/components/schemas/BillableMetricInfo' lastUpdateTime: format: date-time type: string name: maxLength: 50 minLength: 4 type: string organizationId: type: string status: $ref: '#/components/schemas/BillableMetricStatus' type: object BillableMetricAggregationType: enum: - COUNT - UNIQUE_COUNT - SUM - MAX - LAST type: string x-enum-varnames: - BillableMetricAggregationType_COUNT - BillableMetricAggregationType_UNIQUE_COUNT - BillableMetricAggregationType_SUM - BillableMetricAggregationType_MAX - BillableMetricAggregationType_LAST BillableMetricFilter: example: valueType: STRING name: name operation: IS value: '{}' properties: name: type: string operation: $ref: '#/components/schemas/BillableMetricFilterOperation' value: description: The value of the filter. The type of the value depends on the valueType. type: object valueType: $ref: '#/components/schemas/BillableMetricFilterValueType' type: object BillableMetricFilterGroup: example: filters: - valueType: STRING name: name operation: IS value: '{}' - valueType: STRING name: name operation: IS value: '{}' properties: filters: items: $ref: '#/components/schemas/BillableMetricFilter' type: array type: object BillableMetricFilterOperation: enum: - IS - NOT_IS - CONTAINS - NOT_CONTAINS - GT - GTE - LT - LTE - EQ - NOT_EQ - EXISTS - NOT_EXISTS type: string x-enum-varnames: - BillableMetricFilterOperation_IS - BillableMetricFilterOperation_NOT_IS - BillableMetricFilterOperation_CONTAINS - BillableMetricFilterOperation_NOT_CONTAINS - BillableMetricFilterOperation_GT - BillableMetricFilterOperation_GTE - BillableMetricFilterOperation_LT - BillableMetricFilterOperation_LTE - BillableMetricFilterOperation_EQ - BillableMetricFilterOperation_NEQ - BillableMetricFilterOperation_EXISTS - BillableMetricFilterOperation_NOT_EXISTS BillableMetricFilterValueType: enum: - STRING - FLOAT type: string x-enum-varnames: - BillableMetricFilterValueType_STRING - BillableMetricFilterValueType_FLOAT BillableMetricInfo: example: groupBys: - groupBys - groupBys propertyUniqueOn: propertyUniqueOn filterGroups: - filters: - valueType: STRING name: name operation: IS value: '{}' - valueType: STRING name: name operation: IS value: '{}' - filters: - valueType: STRING name: name operation: IS value: '{}' - valueType: STRING name: name operation: IS value: '{}' properties: filterGroups: description: 'FilterGroups is a list of filter groups. The filterGroups are connected by AND.' items: $ref: '#/components/schemas/BillableMetricFilterGroup' type: array groupBys: description: GroupBys is a list of fields to group by. items: type: string type: array propertyUniqueOn: description: The target property for unique count aggregate. type: string type: object BillableMetricStatus: enum: - ACTIVE - DELETED type: string x-enum-varnames: - BillableMetricStatus_ACTIVE - BillableMetricStatus_DELETED BillingAddon: example: organizationID: organizationID creationTime: 2000-01-23 04:56:07+00:00 name: name description: description id: id info: amount: 0.8008281904610115 lastUpdateTime: 2000-01-23 04:56:07+00:00 status: ACTIVE properties: creationTime: format: date-time type: string description: description: Description of the addon maxLength: 300 type: string id: maxLength: 36 type: string info: $ref: '#/components/schemas/BillingAddonInfo' lastUpdateTime: format: date-time type: string name: description: Name of the addon, e.g. "Support Plan" maxLength: 50 minLength: 4 type: string organizationID: type: string status: $ref: '#/components/schemas/BillingAddonStatus' type: object BillingAddonInfo: example: amount: 0.8008281904610115 properties: amount: type: number type: object BillingAddonRecord: example: amount: 0.8008281904610115 name: name description: description chargeOn: 2000-01-23 04:56:07+00:00 id: id properties: amount: type: number chargeOn: format: date-time type: string description: type: string id: type: string name: type: string type: object BillingAddonStatus: enum: - ACTIVE - DELETED type: string x-enum-varnames: - BillingAddonStatus_ACTIVE - BillingAddonStatus_DELETED BillingCycle: enum: - MONTH_FIRST_DAY - ENTITLEMENT_START_DATE type: string x-enum-varnames: - BillingCycle_MonthFirstDay - BillingCycle_EntitlementStartDate BillingDiscount: example: discountType: PERCENTAGE value: 1.4658129805029452 properties: discountType: $ref: '#/components/schemas/BillingDiscountType' value: type: number type: object BillingDiscountType: enum: - PERCENTAGE - ABSOLUTE type: string x-enum-varnames: - BillingDiscountType_PERCENTAGE - BillingDiscountType_ABSOLUTE BillingInvoice: example: creationTime: 2000-01-23 04:56:07+00:00 endDate: 2000-01-23 04:56:07+00:00 entitlementID: entitlementID buyerID: buyerID type: COMMIT organizationID: organizationID invoiceURL: invoiceURL id: id paymentStatus: PENDING startDate: 2000-01-23 04:56:07+00:00 info: deductedCommitAmount: 4.145608029883936 addonDetail: amount: 0.8008281904610115 name: name description: description chargeOn: 2000-01-23 04:56:07+00:00 id: id dueDate: 2000-01-23 04:56:07+00:00 adjustDiscountByDimensions: - reason: reason dimensionKey: dimensionKey discount: discountType: PERCENTAGE value: 1.4658129805029452 - reason: reason dimensionKey: dimensionKey discount: discountType: PERCENTAGE value: 1.4658129805029452 description: description memo: memo adjustOverallMinimumSpend: '{}' currency: currency issueDate: 2000-01-23 04:56:07+00:00 netTermsInDays: 1 trialPeriodInDays: 4 commitsRevenueDetails: - amount: 9.301444243932576 expression: expression quantity: 3 rate: 2.027123023002322 name: name description: description key: key - amount: 9.301444243932576 expression: expression quantity: 3 rate: 2.027123023002322 name: name description: description key: key gracePeriodInDays: 1 periodTotalDays: 6 creationDate: 2000-01-23 04:56:07+00:00 subtotalAmount: 7.457744773683766 addFixedFees: - reason: reason quantity: 0 endDate: 2000-01-23 04:56:07+00:00 rate: 6.027456183070403 startDate: 2000-01-23 04:56:07+00:00 - reason: reason quantity: 0 endDate: 2000-01-23 04:56:07+00:00 rate: 6.027456183070403 startDate: 2000-01-23 04:56:07+00:00 adjustOverallDiscount: '{}' billableDimensionDetails: - discountExpression: discountExpression amount: 5.637376656633329 quantity: 7.061401241503109 minimumCommit: 2.3021358869347655 name: name discount: '{}' details: - feeExpressions: feeExpressions descriptions: descriptions - feeExpressions: feeExpressions descriptions: descriptions billableMetricKey: '{}' category: '{}' isTrial: true minimumCommitScope: '{}' - discountExpression: discountExpression amount: 5.637376656633329 quantity: 7.061401241503109 minimumCommit: 2.3021358869347655 name: name discount: '{}' details: - feeExpressions: feeExpressions descriptions: descriptions - feeExpressions: feeExpressions descriptions: descriptions billableMetricKey: '{}' category: '{}' isTrial: true minimumCommitScope: '{}' paymentInstallmentsDetail: amount: 1.4894159098541704 description: description chargeOn: 2000-01-23 04:56:07+00:00 usageDailyRevenues: - date: date uniquePropertyItems: key: '' quantity: 5.025004791520295 billableMetricKey: groupBysExpression: groupBysExpression id: id - date: date uniquePropertyItems: key: '' quantity: 5.025004791520295 billableMetricKey: groupBysExpression: groupBysExpression id: id dueAmount: 7.386281948385884 isMeteringOverageCommit: true deductedCommitInvoiceID: deductedCommitInvoiceID adjustMinimumSpendByDimensions: - minimumSpend: 5.962133916683182 reason: reason dimensionKey: dimensionKey - minimumSpend: 5.962133916683182 reason: reason dimensionKey: dimensionKey receiptUrl: receiptUrl taxAmount: 1.1730742509559433 spaUrl: spaUrl lastUpdateTime: 2000-01-23 04:56:07+00:00 status: DRAFT properties: buyerID: maxLength: 36 type: string creationTime: format: date-time type: string endDate: format: date-time type: string entitlementID: maxLength: 36 type: string id: maxLength: 36 type: string info: $ref: '#/components/schemas/BillingInvoiceInfo' invoiceURL: description: The invoice file URL, provided as AWS S3 presigned URL with expiration time. Output only. type: string lastUpdateTime: format: date-time type: string organizationID: type: string paymentStatus: $ref: '#/components/schemas/BillingPaymentStatus' startDate: format: date-time type: string status: $ref: '#/components/schemas/BillingInvoiceStatus' type: $ref: '#/components/schemas/BillingInvoiceType' type: object BillingInvoiceInfo: example: deductedCommitAmount: 4.145608029883936 addonDetail: amount: 0.8008281904610115 name: name description: description chargeOn: 2000-01-23 04:56:07+00:00 id: id dueDate: 2000-01-23 04:56:07+00:00 adjustDiscountByDimensions: - reason: reason dimensionKey: dimensionKey discount: discountType: PERCENTAGE value: 1.4658129805029452 - reason: reason dimensionKey: dimensionKey discount: discountType: PERCENTAGE value: 1.4658129805029452 description: description memo: memo adjustOverallMinimumSpend: '{}' currency: currency issueDate: 2000-01-23 04:56:07+00:00 netTermsInDays: 1 trialPeriodInDays: 4 commitsRevenueDetails: - amount: 9.301444243932576 expression: expression quantity: 3 rate: 2.027123023002322 name: name description: description key: key - amount: 9.301444243932576 expression: expression quantity: 3 rate: 2.027123023002322 name: name description: description key: key gracePeriodInDays: 1 periodTotalDays: 6 creationDate: 2000-01-23 04:56:07+00:00 subtotalAmount: 7.457744773683766 addFixedFees: - reason: reason quantity: 0 endDate: 2000-01-23 04:56:07+00:00 rate: 6.027456183070403 startDate: 2000-01-23 04:56:07+00:00 - reason: reason quantity: 0 endDate: 2000-01-23 04:56:07+00:00 rate: 6.027456183070403 startDate: 2000-01-23 04:56:07+00:00 adjustOverallDiscount: '{}' billableDimensionDetails: - discountExpression: discountExpression amount: 5.637376656633329 quantity: 7.061401241503109 minimumCommit: 2.3021358869347655 name: name discount: '{}' details: - feeExpressions: feeExpressions descriptions: descriptions - feeExpressions: feeExpressions descriptions: descriptions billableMetricKey: '{}' category: '{}' isTrial: true minimumCommitScope: '{}' - discountExpression: discountExpression amount: 5.637376656633329 quantity: 7.061401241503109 minimumCommit: 2.3021358869347655 name: name discount: '{}' details: - feeExpressions: feeExpressions descriptions: descriptions - feeExpressions: feeExpressions descriptions: descriptions billableMetricKey: '{}' category: '{}' isTrial: true minimumCommitScope: '{}' paymentInstallmentsDetail: amount: 1.4894159098541704 description: description chargeOn: 2000-01-23 04:56:07+00:00 usageDailyRevenues: - date: date uniquePropertyItems: key: '' quantity: 5.025004791520295 billableMetricKey: groupBysExpression: groupBysExpression id: id - date: date uniquePropertyItems: key: '' quantity: 5.025004791520295 billableMetricKey: groupBysExpression: groupBysExpression id: id dueAmount: 7.386281948385884 isMeteringOverageCommit: true deductedCommitInvoiceID: deductedCommitInvoiceID adjustMinimumSpendByDimensions: - minimumSpend: 5.962133916683182 reason: reason dimensionKey: dimensionKey - minimumSpend: 5.962133916683182 reason: reason dimensionKey: dimensionKey receiptUrl: receiptUrl taxAmount: 1.1730742509559433 spaUrl: spaUrl properties: addFixedFees: description: 'Adjust charge fields The fixed fees to be added to the invoice.' items: $ref: '#/components/schemas/InvoiceAddFixedFee' type: array addonDetail: $ref: '#/components/schemas/BillingAddonRecord' adjustDiscountByDimensions: description: add or adjust discount for a specific dimension items: $ref: '#/components/schemas/InvoiceAdjustDiscountByDimension' type: array adjustMinimumSpendByDimensions: description: add or adjust minimum spend for a specific dimension items: $ref: '#/components/schemas/InvoiceAdjustMinimumSpendByDimension' type: array adjustOverallDiscount: allOf: - $ref: '#/components/schemas/InvoiceAdjustOverallDiscount' description: 'add or adjust overall discount calculate each dimension''s discount first, then apply the overall discount' type: object adjustOverallMinimumSpend: allOf: - $ref: '#/components/schemas/InvoiceAdjustOverallMinimumSpend' description: 'add or adjust overall minimum spend calculate each dimension''s minimum spend first, then apply the overall minimum spend' type: object billableDimensionDetails: items: $ref: '#/components/schemas/BillableDimensionPriceModelDetail' type: array commitsRevenueDetails: description: 'Recurring flat fee for the invoice. There should be only one type fee for each invoice, commits, or usage.' items: $ref: '#/components/schemas/CommitRevenueDetail' type: array creationDate: description: 'The creation date of the invoice when the status of the invoice may be draft or issued. It may be different from the issue date.' format: date-time type: string currency: type: string deductedCommitAmount: description: 'The amount of the committed amount that has been deducted from the usage. It works only when IsMeteringOverageCommit is true.' type: number deductedCommitInvoiceID: description: 'The ID of the commit invoice that has been deducted from the usage. It works only when IsMeteringOverageCommit is true.' type: string description: type: string dueAmount: description: Due amount = SubtotalAmount + TaxAmount - AdjustOverallDiscount type: number dueDate: description: DueDate = IssueDate + NetTerm format: date-time type: string gracePeriodInDays: description: Grace Period in number of days type: integer isMeteringOverageCommit: description: Whether the usage metering is charged for the amount that exceeds the committed amount from the entitlement. type: boolean issueDate: description: 'IssueDate, issue invoice automatically when CreationDate + GracePeriod, or issue invoice manually IssueDate >= CreationDate && IssueDate <= CreationDate + GracePeriod' format: date-time type: string memo: type: string netTermsInDays: description: Net Terms period in number of days type: integer paymentInstallmentsDetail: $ref: '#/components/schemas/BillingPaymentInstallmentDetail' periodTotalDays: description: PeriodTotalDays is the total number of days among the whole periods. e.g. 61 days for a 2-month invoice. type: integer receiptUrl: description: Invoice receipt url, it only exists when there are transactions. type: string spaUrl: description: SPA url with JWT. type: string subtotalAmount: description: Subtotal amount calculated from the user usage. type: number taxAmount: type: number trialPeriodInDays: description: Trial period in number of days type: integer usageDailyRevenues: description: Billable dimension fees for the invoice. items: $ref: '#/components/schemas/BillableDimensionUsageDailyRevenue' type: array type: object BillingInvoiceStatus: enum: - DRAFT - FINALIZED - CANCELED - DELETED - '' type: string x-enum-varnames: - BillingInvoiceStatus_DRAFT - BillingInvoiceStatus_FINALIZED - BillingInvoiceStatus_CANCELED - BillingInvoiceStatus_DELETED - BillingInvoiceStatus_UNKNOWN BillingInvoiceType: enum: - COMMIT - USAGE - ADDON - INSTALLMENT type: string x-enum-varnames: - BillingInvoiceType_COMMIT - BillingInvoiceType_USAGE - BillingInvoiceType_ADDON - BillingInvoiceType_INSTALLMENT BillingMinimumCommitScope: enum: - '' - DIMENSION - DIMENSION_GROUP_BY type: string x-enum-varnames: - BillingMinimumCommitScope_UNKNOWN - BillingMinimumCommitScope_DIMENSION - BillingMinimumCommitScope_DIMENSION_GROUP_BY BillingPaymentInstallmentDetail: example: amount: 1.4894159098541704 description: description chargeOn: 2000-01-23 04:56:07+00:00 properties: amount: type: number chargeOn: format: date-time type: string description: type: string type: object BillingPaymentStatus: enum: - PENDING - PROCESSING - SUCCESS - FAILED type: string x-enum-varnames: - BillingPaymentStatus_PENDING - BillingPaymentStatus_PROCESSING - BillingPaymentStatus_SUCCESS - BillingPaymentStatus_FAILED BillingPaymentTransaction: example: walletID: walletID amount: 0.8008281904610115 creationTime: 2000-01-23 04:56:07+00:00 walletType: ach_debit entitlementID: entitlementID buyerID: buyerID type: CHARGE parentID: parentID organizationID: organizationID partner: '' currency: currency invoiceID: invoiceID id: id info: stripePaymentIntent: '{}' stripeBalanceTransaction: '{}' stripeError: '{}' stripeDisputes: - paymentIntentId: paymentIntentId reason: reason amount: 6 is_charge_refundable: true livemode: true chargeId: chargeId created: 1 id: id status: status - paymentIntentId: paymentIntentId reason: reason amount: 6 is_charge_refundable: true livemode: true chargeId: chargeId created: 1 id: id status: status invoiceDate: 2000-01-23 04:56:07+00:00 stripeRefund: '{}' refundExists: true lastUpdateTime: 2000-01-23 04:56:07+00:00 status: PENDING properties: amount: type: number buyerID: type: string creationTime: format: date-time type: string currency: type: string entitlementID: type: string id: type: string info: $ref: '#/components/schemas/BillingPaymentTransactionInfo' invoiceID: type: string lastUpdateTime: format: date-time type: string organizationID: type: string parentID: type: string partner: $ref: '#/components/schemas/Partner' status: $ref: '#/components/schemas/BillingPaymentStatus' type: $ref: '#/components/schemas/BillingPaymentTransactionType' walletID: type: string walletType: $ref: '#/components/schemas/BillingWalletType' type: object BillingPaymentTransactionInfo: example: stripePaymentIntent: '{}' stripeBalanceTransaction: '{}' stripeError: '{}' stripeDisputes: - paymentIntentId: paymentIntentId reason: reason amount: 6 is_charge_refundable: true livemode: true chargeId: chargeId created: 1 id: id status: status - paymentIntentId: paymentIntentId reason: reason amount: 6 is_charge_refundable: true livemode: true chargeId: chargeId created: 1 id: id status: status invoiceDate: 2000-01-23 04:56:07+00:00 stripeRefund: '{}' refundExists: true properties: invoiceDate: description: The invoice issue date. format: date-time type: string refundExists: description: Refund flag marks whether the transaction has any refund records. type: boolean stripeBalanceTransaction: allOf: - $ref: '#/components/schemas/StripeBalanceTransaction' description: Balance transaction that describes the impact of this charge on your account balance. type: object stripeDisputes: description: Stripe dispute result, got by Dispute API, there may be multiple disputes. items: $ref: '#/components/schemas/StripeDispute' type: array stripeError: allOf: - $ref: '#/components/schemas/StripeError' description: Error of stripe API call type: object stripePaymentIntent: allOf: - $ref: '#/components/schemas/StripePaymentIntent' description: Stripe payment intent result, got by PaymentIntent API type: object stripeRefund: allOf: - $ref: '#/components/schemas/StripeRefund' description: Stripe refund result, got by Refund API type: object type: object BillingPaymentTransactionType: enum: - CHARGE - REFUND type: string x-enum-varnames: - BillingPaymentTransactionType_CHARGE - BillingPaymentTransactionType_REFUND BillingWallet: example: creationTime: 2000-01-23 04:56:07+00:00 usedAmount: 5.637376656633329 externalID: externalID buyerID: buyerID type: ach_debit organizationID: organizationID totalAmount: 5.962133916683182 expireTime: 2000-01-23 04:56:07+00:00 partner: '' name: name currency: currency startTime: 2000-01-23 04:56:07+00:00 id: id info: closeDate: 2000-01-23 04:56:07+00:00 stripePaymentMethod: livemode: true bacs_debit: last4: last4 fingerprint: fingerprint sort_code: sort_code created: 1 us_bank_account: last4: last4 account_type: checking account_holder_type: individual bank_name: bank_name fingerprint: fingerprint routing_number: routing_number sepa_debit: branch_code: branch_code bank_code: bank_code country: country last4: last4 fingerprint: fingerprint id: id card: country: country last4: last4 funding: credit display_brand: display_brand fingerprint: fingerprint exp_month: 0 exp_year: 6 brand: amex object: object stripeSetupIntentId: stripeSetupIntentId lastUpdateTime: 2000-01-23 04:56:07+00:00 status: ACTIVE properties: buyerID: type: string creationTime: format: date-time type: string currency: type: string expireTime: description: nullable format: date-time type: string externalID: description: The payment method id in payment provider, such as stripe payment method id. type: string id: type: string info: $ref: '#/components/schemas/BillingWalletInfo' lastUpdateTime: format: date-time type: string name: type: string organizationID: type: string partner: $ref: '#/components/schemas/Partner' startTime: format: date-time type: string status: $ref: '#/components/schemas/BillingWalletStatus' totalAmount: type: number type: $ref: '#/components/schemas/BillingWalletType' usedAmount: type: number type: object BillingWalletInfo: example: closeDate: 2000-01-23 04:56:07+00:00 stripePaymentMethod: livemode: true bacs_debit: last4: last4 fingerprint: fingerprint sort_code: sort_code created: 1 us_bank_account: last4: last4 account_type: checking account_holder_type: individual bank_name: bank_name fingerprint: fingerprint routing_number: routing_number sepa_debit: branch_code: branch_code bank_code: bank_code country: country last4: last4 fingerprint: fingerprint id: id card: country: country last4: last4 funding: credit display_brand: display_brand fingerprint: fingerprint exp_month: 0 exp_year: 6 brand: amex object: object stripeSetupIntentId: stripeSetupIntentId properties: closeDate: description: The close date of the wallet if applicable. format: date-time type: string stripePaymentMethod: $ref: '#/components/schemas/StripePaymentMethod' stripeSetupIntentId: type: string type: object BillingWalletStatus: enum: - ACTIVE - DELETED - PENDING_VERIFY - EXPIRED - CLOSED type: string x-enum-comments: BillingWalletStatus_DELETED: Soft delete. BillingWalletStatus_EXPIRED: for credit. BillingWalletStatus_PENDING_VERIFY: for payment method. x-enum-varnames: - BillingWalletStatus_ACTIVE - BillingWalletStatus_DELETED - BillingWalletStatus_PENDING_VERIFY - BillingWalletStatus_EXPIRED - BillingWalletStatus_CLOSED BillingWalletType: enum: - ach_debit - bacs_debit - card - credit - sepa_debit type: string x-enum-comments: BillingWalletType_ACH_DEBIT: for USD. BillingWalletType_BACS_DEBIT: for UK. BillingWalletType_CREDIT: Credit managed by Suger. BillingWalletType_SEPA_DEBIT: for EUR. x-enum-varnames: - BillingWalletType_ACH_DEBIT - BillingWalletType_BACS_DEBIT - BillingWalletType_CARD - BillingWalletType_CREDIT - BillingWalletType_SEPA_DEBIT BuyerInfo: example: stripeBuyer: '{}' invoicedAmount: 5.962133916683182 snowflakeBuyer: '{}' companyInfo: country: country emailDomain: emailDomain city: city postalCode: postalCode name: name addressLine1: addressLine1 addressLine2: addressLine2 state: state validFrom: validFrom gcpBuyer: '{}' lastModifiedBy: lastModifiedBy grossAmount: 1.4658129805029452 collectableAmount: 0.8008281904610115 paymentConfig: '{}' emailAddress: emailAddress orbCustomerId: orbCustomerId adyenBuyer: '{}' azureBuyer: '{}' customerId: customerId lagoCustomerId: lagoCustomerId awsBuyer: '{}' fields: key: '' metronomeCustomerId: metronomeCustomerId stripeCustomerId: stripeCustomerId disbursedAmount: 6.027456183070403 spaUrl: spaUrl properties: adyenBuyer: allOf: - $ref: '#/components/schemas/AdyenBuyer' description: Buyer on Adyen type: object awsBuyer: allOf: - $ref: '#/components/schemas/AwsAccountIdentifier' description: Buyer from AWS Marketplace type: object azureBuyer: allOf: - $ref: '#/components/schemas/AzureADIdentifier' description: Buyer from Azure Marketplace type: object collectableAmount: description: The amount that the seller can collect. It excludes the marketplace commision fee. type: number companyInfo: $ref: '#/components/schemas/CompanyInfo' customerId: description: customerID of buyer on seller's side type: string disbursedAmount: description: The amount that has been disbursed to the seller account. type: number emailAddress: description: The email address of the buyer. This was copied from the new client signup form. type: string fields: additionalProperties: true description: Fields to store key-value pairs of buyer information. type: object gcpBuyer: allOf: - $ref: '#/components/schemas/GcpMarketplaceUserAccount' description: Buyer from GCP Marketplace type: object grossAmount: description: The gross amount that the buyer has committed to pay, including usage metered amount. type: number invoicedAmount: description: The amount that the buyer has got invoiced. type: number lagoCustomerId: description: The lgo customer ID for the buyer if it is connected to a lago customer. type: string lastModifiedBy: description: Last modifier user ID. type: string metronomeCustomerId: description: The metronome customer ID for the buyer if it is connected to a metronome customer. type: string orbCustomerId: description: The orb customer ID for the buyer if it is connected to a orb customer. type: string paymentConfig: allOf: - $ref: '#/components/schemas/PaymentConfig' description: Payment Config for billing. type: object snowflakeBuyer: allOf: - $ref: '#/components/schemas/SnowflakeMarketplaceBuyer' description: Buyer on Snowflake type: object spaUrl: description: Buyer SPA url, public page visited with jwt. type: string stripeBuyer: allOf: - $ref: '#/components/schemas/StripeCustomer' description: Buyer as Customer on Stripe type: object stripeCustomerId: description: The stripe customer ID for the buyer if it is connected to a stripe customer. type: string type: object CancellationSchedule: example: note: note cancelDate: cancelDate creationDate: creationDate type: '{}' properties: cancelDate: description: The cancellation date of the entitlement. It is required when the type is SpecificDate. type: string creationDate: description: When this cancellation schedule is created. type: string note: description: The cancellation note. Max 500 characters. maxLength: 500 type: string type: allOf: - $ref: '#/components/schemas/CancellationScheduleType' description: Cancellation type type: object type: object CancellationScheduleType: enum: - EndOfTerm - Immediate - SpecificDate type: string x-enum-varnames: - CancellationScheduleType_EndOfTerm - CancellationScheduleType_Immediate - CancellationScheduleType_SpecificDate CommitDimension: description: The commit dimension. There may be one or more commit dimensions defined in single product, offer or entitlement. example: types: - types - types quantity: 4 length: 9 description: description type: '{}' maximumUsers: 361608 rate: 7.386281948385884 isUserCreated: true minimumUsers: 202713 name: name term: term category: category termEndTime: termEndTime key: key timeUnit: '{}' properties: category: type: string description: type: string isUserCreated: description: 'Whether this commit dimension is newly created by user, when creating AWS Marketplace Contract private offer.' type: boolean key: description: API name of the dimension type: string length: description: 'The term length for the commit amount, such as 6 months, or 1 year. The length is used together with timeUnit. If the length is zero, use the TermEndTime.' type: integer maximumUsers: description: The maximum number of users for PER_USER commit maximum: 1000000 minimum: 1 type: integer minimumUsers: description: The minimum number of users for PER_USER commit maximum: 1000000 minimum: 1 type: integer name: description: Display name of the dimension type: string quantity: description: The quantity of this commit. type: integer rate: description: The commit amount. For GCP, it is monthly commitment. type: number term: description: The term of the commit amount. It is used for front-end display only. type: string termEndTime: description: The end time of the commit term. type: string timeUnit: allOf: - $ref: '#/components/schemas/TimeUnit' description: The term unit for the commit amount. type: object type: allOf: - $ref: '#/components/schemas/CommitDimensionType' description: The type of the commit dimension. Applicable only to Azure Marketplace. type: object types: description: These indicate whether the dimension covers metering, entitlement, or support for external metering items: type: string type: array type: object CommitDimensionType: enum: - FLAT_RATE - PER_USER type: string x-enum-varnames: - CommitDimensionType_FLAT_RATE - CommitDimensionType_PER_USER CommitRevenueDetail: example: amount: 9.301444243932576 expression: expression quantity: 3 rate: 2.027123023002322 name: name description: description key: key properties: amount: description: The total amount of the commit revenue. type: number description: type: string expression: type: string key: type: string name: type: string quantity: description: The quantity of the commit dimension. Default is 1. type: integer rate: description: The unit price of the commit dimension. type: number type: object CompanyInfo: example: country: country emailDomain: emailDomain city: city postalCode: postalCode name: name addressLine1: addressLine1 addressLine2: addressLine2 state: state validFrom: validFrom properties: addressLine1: type: string addressLine2: type: string city: type: string country: type: string emailDomain: type: string name: type: string postalCode: type: string state: type: string validFrom: description: When the company info becomes valid. in format "2006-01-02T15:04:05Z" type: string type: object Contact: example: name: name company: company email: email properties: company: type: string email: type: string name: type: string type: object CreateAndUpdateAddonParams: example: amount: 0.8008281904610115 name: name description: description properties: amount: description: The amount of the addon. type: number description: description: The description of the addon. maxLength: 300 type: string name: description: The name of the addon. maxLength: 50 minLength: 4 type: string type: object CreateBuyerParams: example: paymentConfig: '{}' orbCustomerId: orbCustomerId partner: '{}' companyInfo: '{}' customerId: customerId name: name description: description adyenCustomerId: adyenCustomerId lagoCustomerId: lagoCustomerId metronomeCustomerId: metronomeCustomerId stripeCustomerId: stripeCustomerId properties: adyenCustomerId: description: Adyen customerId of this buyer. If not provided but Partner is ADYEN, will create a new customer on Adyen. type: string companyInfo: allOf: - $ref: '#/components/schemas/CompanyInfo' description: Optional. CompanyInfo of the buyer. type: object customerId: description: The customer ID to recognize the cloud marketplace buyer in your internal system. type: string description: description: The description of the buyer. type: string lagoCustomerId: description: Optional. The Lago Customer ID of the buyer. type: string metronomeCustomerId: description: Optional. The Metronome Customer ID of the buyer. type: string name: description: The name of the buyer. type: string orbCustomerId: description: Optional. The Orb Customer ID of the buyer. type: string partner: allOf: - $ref: '#/components/schemas/Partner' description: The channel partner where this buyer is billed. Only STRIPE & ADYEN are supported at the moment. type: object paymentConfig: allOf: - $ref: '#/components/schemas/PaymentConfig' description: Payment config for billing. type: object stripeCustomerId: description: Stripe customerId of this buyer. If not provided but Partner is STRIPE, will create a new customer on stripe. type: string type: object CreateEntitlementParams: example: organizationId: organizationId endDate: endDate offerId: offerId buyerId: buyerId startDate: startDate properties: buyerId: type: string endDate: description: 'The end date of the entitlement. If it is null, the entitlement will ends based on the offer. If it is in the past, the entitlement will be created as CANCELLED status.' type: string offerId: type: string organizationId: type: string startDate: description: 'The start date of the entitlement. If it is null, the entitlement starts immediately. It can be in the future or in the past.' type: string type: object CreateUsageRecordGroupParams: example: organizationID: organizationID metaInfo: '{}' records: key: 0.8008281904610115 billableRecords: - quantity: 0.8008281904610115 key: key properties: key: '' - quantity: 0.8008281904610115 key: key properties: key: '' entitlementID: entitlementID id: id timestamp: 2000-01-23 04:56:07+00:00 properties: billableRecords: description: for usage metering API v2, don't use it together with the records v1. items: $ref: '#/components/schemas/MeteringUsageRecord' type: array entitlementID: type: string id: description: 'The uuid of the UsageRecordGroup (the size is up to 36 characters). Optional, if not provided, suger will generate one.' type: string metaInfo: allOf: - $ref: '#/components/schemas/MeteringUsageRecordGroupMetaInfo' description: read-only, don't set it up when reporting the usage record group. type: object organizationID: type: string records: additionalProperties: type: number description: for usage metering API v1, don't use it together with the billableRecords v2. type: object timestamp: description: 'The timestamp of when the usage records were generated. Optional, if not provided, the current report timestamp will be used. This is not the timestamp of when the usage records were reported to Suger.' format: date-time type: string required: - entitlementID - organizationID - records type: object DivideEntitlementCommitParams: example: startDates: - 2000-01-23 04:56:07+00:00 - 2000-01-23 04:56:07+00:00 commitAmount: 0.8008281904610115 properties: commitAmount: description: 'The amount of the commit to be divided. If it is less or equal to 0.0, the total commit of the entitlement will be divided into multiple sub entitlement terms with credit.' type: number startDates: description: 'The start dates of the sub entitlement terms. The end date of the last sub entitlement term is the end date of the parent entitlement term. The first start date must be the same as the start date of the parent entitlement term.' items: format: date-time type: string type: array type: object EntitlementInfo: example: alibabaOrders: - PaidOn: 1 CouponPrice: 2.027123023002322 PeriodType: PeriodType OriginalPrice: 1.2315135367772556 PayStatus: PayStatus ProductName: ProductName RequestId: RequestId ProductCode: ProductCode SupplierCompanyName: SupplierCompanyName Quantity: 6 OrderId: 7 SupplierTelephones: Telephone: - Telephone - Telephone Components: key: '' OrderStatus: OrderStatus OrderType: OrderType TotalPrice: 7.457744773683766 ProductSkuCode: ProductSkuCode CreatedOn: 4 PaymentPrice: 1.4894159098541704 InstanceIds: InstanceId: - InstanceId - InstanceId AccountQuantity: 9 AliUid: 3 - PaidOn: 1 CouponPrice: 2.027123023002322 PeriodType: PeriodType OriginalPrice: 1.2315135367772556 PayStatus: PayStatus ProductName: ProductName RequestId: RequestId ProductCode: ProductCode SupplierCompanyName: SupplierCompanyName Quantity: 6 OrderId: 7 SupplierTelephones: Telephone: - Telephone - Telephone Components: key: '' OrderStatus: OrderStatus OrderType: OrderType TotalPrice: 7.457744773683766 ProductSkuCode: ProductSkuCode CreatedOn: 4 PaymentPrice: 1.4894159098541704 InstanceIds: InstanceId: - InstanceId - InstanceId AccountQuantity: 9 AliUid: 3 invoicedAmount: 6.438423552598547 addons: - amount: 0.8008281904610115 name: name description: description chargeOn: 2000-01-23 04:56:07+00:00 id: id - amount: 0.8008281904610115 name: name description: description chargeOn: 2000-01-23 04:56:07+00:00 id: id trialConfig: '{}' azureSubscriptions: - fulfillmentId: fulfillmentId quantity: 1 allowedCustomerOperations: - Read - Read created: 2000-01-23 04:56:07+00:00 purchaser: firstName: firstName lastName: lastName licenseType: licenseType puid: puid customerId: customerId tenantId: tenantId billingAccountId: billingAccountId emailId: emailId objectId: objectId isFreeTrial: true sessionId: sessionId saasSubscriptionStatus: NotStarted publisherId: publisherId beneficiary: firstName: firstName lastName: lastName licenseType: licenseType puid: puid customerId: customerId tenantId: tenantId billingAccountId: billingAccountId emailId: emailId objectId: objectId isTest: true name: name autoRenew: true offerId: offerId planId: planId storeFront: storeFront term: endDate: 2000-01-23 04:56:07+00:00 chargeDuration: chargeDuration startDate: 2000-01-23 04:56:07+00:00 termUnit: termUnit id: id lastModified: lastModified sandboxType: None sessionMode: None - fulfillmentId: fulfillmentId quantity: 1 allowedCustomerOperations: - Read - Read created: 2000-01-23 04:56:07+00:00 purchaser: firstName: firstName lastName: lastName licenseType: licenseType puid: puid customerId: customerId tenantId: tenantId billingAccountId: billingAccountId emailId: emailId objectId: objectId isFreeTrial: true sessionId: sessionId saasSubscriptionStatus: NotStarted publisherId: publisherId beneficiary: firstName: firstName lastName: lastName licenseType: licenseType puid: puid customerId: customerId tenantId: tenantId billingAccountId: billingAccountId emailId: emailId objectId: objectId isTest: true name: name autoRenew: true offerId: offerId planId: planId storeFront: storeFront term: endDate: 2000-01-23 04:56:07+00:00 chargeDuration: chargeDuration startDate: 2000-01-23 04:56:07+00:00 termUnit: termUnit id: id lastModified: lastModified sandboxType: None sessionMode: None awsEntitlements: - productCode: productCode customerIdentifier: customerIdentifier dimension: dimension value: '{}' expirationDate: expirationDate - productCode: productCode customerIdentifier: customerIdentifier dimension: dimension value: '{}' expirationDate: expirationDate gcpEntitlements: - newPendingOffer: newPendingOffer offerEffectiveTime: 2000-01-23 04:56:07+00:00 newPlan: newPlan offer: offer inputProperties: - 6 - 6 provider: provider offerEndTime: 2000-01-23 04:56:07+00:00 offerDuration: offerDuration consumers: - project: project - project: project newOfferEndTime: newOfferEndTime subscriptionEndTime: 2000-01-23 04:56:07+00:00 id: id state: '{}' usageReportingId: usageReportingId plan: plan messageToUser: messageToUser product: product updateTime: 2000-01-23 04:56:07+00:00 newOfferDuration: newOfferDuration quoteExternalName: quoteExternalName createTime: 2000-01-23 04:56:07+00:00 newPendingPlan: newPendingPlan name: name newPendingOfferDuration: newPendingOfferDuration account: account productExternalName: productExternalName newOfferStartTime: newOfferStartTime - newPendingOffer: newPendingOffer offerEffectiveTime: 2000-01-23 04:56:07+00:00 newPlan: newPlan offer: offer inputProperties: - 6 - 6 provider: provider offerEndTime: 2000-01-23 04:56:07+00:00 offerDuration: offerDuration consumers: - project: project - project: project newOfferEndTime: newOfferEndTime subscriptionEndTime: 2000-01-23 04:56:07+00:00 id: id state: '{}' usageReportingId: usageReportingId plan: plan messageToUser: messageToUser product: product updateTime: 2000-01-23 04:56:07+00:00 newOfferDuration: newOfferDuration quoteExternalName: quoteExternalName createTime: 2000-01-23 04:56:07+00:00 newPendingPlan: newPendingPlan name: name newPendingOfferDuration: newPendingOfferDuration account: account productExternalName: productExternalName newOfferStartTime: newOfferStartTime paymentInstallments: - discountPercentage: 3.5571952270680973 amount: 9.018348186070783 originalAmount: 6.965117697638846 chargeOn: 2000-01-23 04:56:07+00:00 chargeOnStr: chargeOnStr credit: 6.438423552598547 - discountPercentage: 3.5571952270680973 amount: 9.018348186070783 originalAmount: 6.965117697638846 chargeOn: 2000-01-23 04:56:07+00:00 chargeOnStr: chargeOnStr credit: 6.438423552598547 billableDimensions: - priceModelTiered: '{}' priceModelTieredPercentage: '{}' priceModelMatrix: '{}' minimumCommit: 5.962133916683182 length: 1 priceModelBulk: '{}' description: description discount: '{}' minimumCommitScope: '{}' minimumCommitProrata: true billableMetricId: billableMetricId priceModelPercentage: '{}' name: name priceModelBasic: '{}' category: '{}' priceModelVolume: '{}' timeUnit: '{}' - priceModelTiered: '{}' priceModelTieredPercentage: '{}' priceModelMatrix: '{}' minimumCommit: 5.962133916683182 length: 1 priceModelBulk: '{}' description: description discount: '{}' minimumCommitScope: '{}' minimumCommitProrata: true billableMetricId: billableMetricId priceModelPercentage: '{}' name: name priceModelBasic: '{}' category: '{}' priceModelVolume: '{}' timeUnit: '{}' eulaUrl: eulaUrl billingIntervalInMonths: 4 refundCancellationPolicy: refundCancellationPolicy paymentSchedule: '{}' autoRenew: true currency: currency alibabaEntitlements: - Status: Status ProductName: ProductName EndOn: 5 InstanceId: 2 ProductCode: ProductCode Modules: Module: - Id: Id Properties: Property: - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark DisplayUnit: DisplayUnit Key: Key Name: Name ShowType: ShowType - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark DisplayUnit: DisplayUnit Key: Key Name: Name ShowType: ShowType Code: Code Name: Name - Id: Id Properties: Property: - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark DisplayUnit: DisplayUnit Key: Key Name: Name ShowType: ShowType - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark DisplayUnit: DisplayUnit Key: Key Name: Name ShowType: ShowType Code: Code Name: Name RelationalData: ServiceStatus: ServiceStatus AppJson: AppJson ProductType: ProductType OrderId: 7 Constraints: Constraints AutoRenewal: AutoRenewal ExtendJson: ExtendJson ComponentJson: ComponentJson IsTrial: true SupplierName: SupplierName ProductSkuCode: ProductSkuCode CreatedOn: 5 HostJson: HostJson BeganOn: 1 - Status: Status ProductName: ProductName EndOn: 5 InstanceId: 2 ProductCode: ProductCode Modules: Module: - Id: Id Properties: Property: - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark DisplayUnit: DisplayUnit Key: Key Name: Name ShowType: ShowType - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark DisplayUnit: DisplayUnit Key: Key Name: Name ShowType: ShowType Code: Code Name: Name - Id: Id Properties: Property: - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark DisplayUnit: DisplayUnit Key: Key Name: Name ShowType: ShowType - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark DisplayUnit: DisplayUnit Key: Key Name: Name ShowType: ShowType Code: Code Name: Name RelationalData: ServiceStatus: ServiceStatus AppJson: AppJson ProductType: ProductType OrderId: 7 Constraints: Constraints AutoRenewal: AutoRenewal ExtendJson: ExtendJson ComponentJson: ComponentJson IsTrial: true SupplierName: SupplierName ProductSkuCode: ProductSkuCode CreatedOn: 5 HostJson: HostJson BeganOn: 1 disbursedAmount: 9.369310271410669 netTermsInDays: 3 dimensionsOversized: true eulaType: '' gracePeriodInDays: 8 grossAmount: 9.018348186070783 gcpPlans: - priceInfo: usageFees: - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 subscriptionPlans: - period: period price: nanos: 1 units: units currencyCode: currencyCode - period: period price: nanos: 1 units: units currencyCode: currencyCode description: description priceModel: FREE purchaseMode: PURCHASE_MODE_PRIVATE name: name title: title featureValues: - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription - priceInfo: usageFees: - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 subscriptionPlans: - period: period price: nanos: 1 units: units currencyCode: currencyCode - period: period price: nanos: 1 units: units currencyCode: currencyCode description: description priceModel: FREE purchaseMode: PURCHASE_MODE_PRIVATE name: name title: title featureValues: - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription collectableAmount: 5.025004791520295 buyerManagementURL: buyerManagementURL alertDaysBeforeEnd: 6 sellerNotes: sellerNotes awsAgreement: '{}' billingCycle: '{}' commits: - types: - types - types quantity: 4 length: 9 description: description type: '{}' maximumUsers: 361608 rate: 7.386281948385884 isUserCreated: true minimumUsers: 202713 name: name term: term category: category termEndTime: termEndTime key: key timeUnit: '{}' - types: - types - types quantity: 4 length: 9 description: description type: '{}' maximumUsers: 361608 rate: 7.386281948385884 isUserCreated: true minimumUsers: 202713 name: name term: term category: category termEndTime: termEndTime key: key timeUnit: '{}' isMeteringOverageCommit: true awsChannelPartner: '{}' commitAmount: 9.965781217890562 dimensions: - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 types: - types - types description: description planName: planName usageCount: '{}' rate: 6.84685269835264 includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly valueType: '{}' name: name planId: planId category: category key: key skuId: skuId - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 types: - types - types description: description planName: planName usageCount: '{}' rate: 6.84685269835264 includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly valueType: '{}' name: name planId: planId category: category key: key skuId: skuId snowflakeOffer: '{}' spaUrl: spaUrl properties: addons: description: The addons for the entitlement. items: $ref: '#/components/schemas/BillingAddonRecord' type: array alertDaysBeforeEnd: description: Alert days before the end of the entitlement type: integer alibabaEntitlements: description: Nullable. Alibaba Entitlements from Alibaba Marketplace. items: $ref: '#/components/schemas/client.DescribeInstanceResponseBody' type: array alibabaOrders: description: Nullable. Alibaba Orders from Alibaba Marketplace. items: $ref: '#/components/schemas/client.DescribeOrderResponseBody' type: array autoRenew: description: Is this Entitlement Auto Renew enabled. type: boolean awsAgreement: allOf: - $ref: '#/components/schemas/AwsMarketplaceAgreementV2' description: Nullable. AWS agreement from AWS Marketplace. type: object awsChannelPartner: allOf: - $ref: '#/components/schemas/AwsChannelPartner' description: The AWS channel partner (reseller), only applicable if this entitlement is based on AWS CPPO offer. type: object awsEntitlements: description: Nullable. AWS Entitlements from AWS Marketplace. items: $ref: '#/components/schemas/types.Entitlement' type: array azureSubscriptions: description: Nullable. Azure Subscriptions from Azure Marketplace. items: $ref: '#/components/schemas/AzureMarketplaceSubscription' type: array billableDimensions: description: The dimensions for billable metric usage-based metering. It's for Suger(Stripe, Ayden) metering. items: $ref: '#/components/schemas/BillableDimension' type: array billingCycle: allOf: - $ref: '#/components/schemas/BillingCycle' description: Billing Cycle type: object billingIntervalInMonths: description: The billing interval from the offer. type: integer buyerManagementURL: description: 'The buyer''s management URL in the cloud marketplace. For different cloud marketplaces, the buyer management URL maybe different.' type: string collectableAmount: description: The amount that the seller can collect. It excludes the marketplace commision fee. type: number commitAmount: description: 'The amount that the buyer has committed to pay. It can be the sum of payment installments if applicable.' type: number commits: description: The dimensions for flatrate commitment (recurring or one-time). items: $ref: '#/components/schemas/CommitDimension' type: array currency: description: The default Currency is USD. type: string dimensions: description: 'The dimensions for usage-based metering. It''s for usage metering in cloud marketplaces. The max size of dimensions is 50. The oversized dimensions won''t be saved in the EntitlementInfo. But the dimensions can be accessed from the connected offer info or product info.' items: $ref: '#/components/schemas/MeteringDimension' type: array dimensionsOversized: description: Whether the upper metering dimensions are oversized (exceed the max size 50). type: boolean disbursedAmount: description: The amount that has been disbursed to the seller account. type: number eulaType: $ref: '#/components/schemas/EulaType' eulaUrl: type: string gcpEntitlements: description: Nullable. GCP Entitlements from GCP Marketplace. items: $ref: '#/components/schemas/GcpMarketplaceEntitlement' type: array gcpPlans: description: Only applicable for GCP Marketplace Entitlements. items: $ref: '#/components/schemas/GcpMarketplaceProductPurchaseOptionSpec' type: array gracePeriodInDays: description: 'The grace period for the offer. It is same as the TrialConfig in DirectOfferInfo. But can be overridden at the entitlement level.' type: integer grossAmount: description: The gross amount that the buyer has committed to pay, including usage metered amount. type: number invoicedAmount: description: The amount that the buyer has got invoiced. type: number isMeteringOverageCommit: description: Whether the usage metering will be charged for the amount that exceeds the committed amount from the offer. type: boolean netTermsInDays: description: 'The net terms for the offer. It is same as the TrialConfig in DirectOfferInfo. But can be overridden at the entitlement level.' type: integer paymentInstallments: description: For flexible payment schedules items: $ref: '#/components/schemas/PaymentInstallment' type: array paymentSchedule: allOf: - $ref: '#/components/schemas/PaymentScheduleType' description: 'The payment schedule for the entitlement. PREPAY means the buyer pays before the service is provided. POSTPAY means the buyer pays after the service is provided.' type: object refundCancellationPolicy: type: string sellerNotes: type: string snowflakeOffer: allOf: - $ref: '#/components/schemas/SnowflakeMarketplaceOffer' description: Snowfalke offer info type: object spaUrl: description: The URL with JWT as auth method for the entitlement SPA. It can be shared with the buyer to access the SPA without login. type: string trialConfig: allOf: - $ref: '#/components/schemas/TrialConfig' description: 'The trial configuration for the offer. It is same as the TrialConfig in DirectOfferInfo. But can be overridden at the entitlement level.' type: object type: object EntitlementStatus: enum: - '' - ACTIVE - CANCELLED - DELETED - PENDING_CANCEL - PENDING_START - SUSPENDED type: string x-enum-varnames: - EntitlementStatus_UNKNOWN - EntitlementStatus_ACTIVE - EntitlementStatus_CANCELLED - EntitlementStatus_DELETED - EntitlementStatus_PENDING_CANCEL - EntitlementStatus_PENDING_START - EntitlementStatus_SUSPENDED EntitlementTermInfo: example: dimensionQuantityDecimalParts: key: 1.4658129805029452 parentEntitlementTermId: parentEntitlementTermId type: '' subEntitlementTermIds: - subEntitlementTermIds - subEntitlementTermIds isCommitDivided: true properties: dimensionQuantityDecimalParts: additionalProperties: type: number description: 'The decimal part of the dimension quantity, in format of It is used to save the decimal part of the dimension quantity for AWS Marketplace only. Because AWS Marketplace only accepts integer for dimension quantity. If the dimension quantity is a decimal number, we need to save the decimal part for future use.' type: object isCommitDivided: description: 'Whether the commit is divided into multiple sub entitlement terms. If true, it has subEntitlementTermIds.' type: boolean parentEntitlementTermId: description: 'The partner''s entitlement term ID. It stands for the partner''s entitlement term. Applicable to the sub entitlement term only.' type: string subEntitlementTermIds: description: All sub entitlement terms id of this entitlement term if it is commit divided. items: type: string type: array type: $ref: '#/components/schemas/EntitlementTermType' type: object EntitlementTermType: enum: - '' - AutoRenew - ManualRenew - PlanChange - QuantityChange - Signup - DivideCommit type: string x-enum-comments: EntitlementTermTypeManualRenew: also for Upsell x-enum-varnames: - EntitlementTermTypeUnknown - EntitlementTermTypeAutoRenew - EntitlementTermTypeManualRenew - EntitlementTermTypePlanChange - EntitlementTermTypeQuantityChange - EntitlementTermTypeSignup - EntitlementTermTypeDivideCommit EntityType: enum: - '' - API_CLIENT - AUDITING_EVENT - AUTO_SHARE_TASK - BUYER - CONTACT - ENTITLEMENT - ENTITLEMENT_TERM - HEADLESS_ENTITLEMENTS - HUBSPOT_USER - INTEGRATION - INVOICE - NEW_CLIENT - NOTIFICATION_MESSAGE - OFFER - ORGANIZATION - PAYMENT_TRANSACTION - PRODUCT - REFERRAL - REVENUE_RECORD - SUPPORT_TICKET - UNPURCHASED_OFFERS - USAGE_RECORD_GROUP - USAGE_RECORD_REPORT - USER - WORKFLOW - WORKFLOW_EXECUTION - WORKFLOW_WEBHOOK type: string x-enum-varnames: - EntityType_UNKNOWN - EntityType_API_CLIENT - EntityType_AUDITING_EVENT - EntityType_AUTO_SHARE_TASK - EntityType_BUYER - EntityType_CONTACT - EntityType_ENTITLEMENT - EntityType_ENTITLEMENT_TERM - EntityType_HEADLESS_ENTITLEMENTS - EntityType_HUBSPOT_USER - EntityType_INTEGRATION - EntityType_INVOICE - EntityType_NEW_CLIENT - EntityType_NOTIFICATION_MESSAGE - EntityType_OFFER - EntityType_ORGANIZATION - EntityType_PAYMENT_TRANSACTION - EntityType_PRODUCT - EntityType_REFERRAL - EntityType_REVENUE_RECORD - EntityType_SUPPORT_TICKET - EntityType_UNPURCHASED_OFFERS - EntityType_USAGE_RECORD_GROUP - EntityType_USAGE_RECORD_REPORT - EntityType_USER - EntityType_WORKFLOW - EntityType_WORKFLOW_EXECUTION - EntityType_WORKFLOW_WEBHOOK EulaType: enum: - '' - SCMP - ECMP - RCMP - CUSTOM - ISV - CURRENT type: string x-enum-comments: EulaType_CURRENT: Current EULA, used for existing entitlement. EulaType_CUSTOM: Custom EULA EulaType_ECMP: AWS Enterprise Contract EULA EulaType_ISV: ISV standard / default EULA EulaType_RCMP: AWS Reseller Contract EULA EulaType_SCMP: AWS Standard Contract EULA x-enum-varnames: - EulaType_UNKNOWN - EulaType_SCMP - EulaType_ECMP - EulaType_RCMP - EulaType_CUSTOM - EulaType_ISV - EulaType_CURRENT GcpAgreementDocument: properties: key: type: string name: type: string type: object GcpAmountConstraint: example: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units properties: defaultAmount: $ref: '#/components/schemas/GcpAmountUnit' maxAmount: $ref: '#/components/schemas/GcpAmountUnit' minAmount: $ref: '#/components/schemas/GcpAmountUnit' type: object GcpAmountUnit: example: nanos: 9 units: units properties: nanos: type: integer units: type: string type: object GcpCommitmentAmountPerPeriodTemplate: example: decimalAmountConstraint: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units currencyCode: currencyCode properties: currencyCode: type: string decimalAmountConstraint: $ref: '#/components/schemas/GcpAmountConstraint' type: object GcpMarketplaceAgreementDocument: properties: eulaAgreementDocument: $ref: '#/components/schemas/GcpMarketplaceDocument' sowAgreementDocument: $ref: '#/components/schemas/GcpMarketplaceDocument' type: object GcpMarketplaceConsumer: example: project: project properties: project: description: The project name with format `projects/`. type: string type: object GcpMarketplaceDocument: example: documentBody: documentBody documentType: documentType unstructuredDocument: content: content name: name description: description updateTime: 2000-01-23 04:56:07+00:00 externalGoogleLink: '{}' properties: description: type: string documentBody: type: string documentType: description: such as "PARTNER_EULA" type: string externalGoogleLink: allOf: - $ref: '#/components/schemas/GcpMarketplaceExternalGoogleLink' description: The external link to Standard EULA such as https://cloud.google.com/terms/marketplace/eula-standard-v2-01272021. type: object name: description: in format of "projects/{projectNumber}/agreements/{agreementId}/documents/{documentId}" type: string unstructuredDocument: $ref: '#/components/schemas/GcpMarketplaceUnstructuredDocument' updateTime: format: date-time type: string type: object GcpMarketplaceEntitlement: example: newPendingOffer: newPendingOffer offerEffectiveTime: 2000-01-23 04:56:07+00:00 newPlan: newPlan offer: offer inputProperties: - 6 - 6 provider: provider offerEndTime: 2000-01-23 04:56:07+00:00 offerDuration: offerDuration consumers: - project: project - project: project newOfferEndTime: newOfferEndTime subscriptionEndTime: 2000-01-23 04:56:07+00:00 id: id state: '{}' usageReportingId: usageReportingId plan: plan messageToUser: messageToUser product: product updateTime: 2000-01-23 04:56:07+00:00 newOfferDuration: newOfferDuration quoteExternalName: quoteExternalName createTime: 2000-01-23 04:56:07+00:00 newPendingPlan: newPendingPlan name: name newPendingOfferDuration: newPendingOfferDuration account: account productExternalName: productExternalName newOfferStartTime: newOfferStartTime properties: account: description: 'The resource name of the account that this entitlement is based on, if any, in format ""providers/{provider_id}/accounts/{account_id}"' type: string consumers: description: The resources using this entitlement, if applicable. items: $ref: '#/components/schemas/GcpMarketplaceConsumer' type: array createTime: format: date-time type: string id: description: Entitlement Id generated by GCP Marketplace. For Marketplace pub/sub event. type: string inputProperties: description: The custom properties that were collected from the user to create this entitlement. items: type: integer type: array messageToUser: description: 'Provider-supplied message that is displayed to the end user. Currently this is used to communicate progress and ETA for provisioning. This field can be updated only when a user is waiting for an action from the provider, i.e. entitlement state is EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED or EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL. This field is cleared automatically when the entitlement state changes.' type: string name: description: 'The resource name of the entitlement. Entitlement names have the form of `providers/{provider_id}/entitlements/{entitlement_id}`.' type: string newOfferDuration: description: in ISO 8601 duration format, such as "P2Y3M". For Marketplace pub/sub event. type: string newOfferEndTime: description: 'Output only. The end time of the new offer. Field is empty if the pending plan change is not moving to an offer. If the offer was created with a term instead of a specified end date, this field is empty.' type: string newOfferStartTime: description: Output only. The start time of the new offer. Field is empty if the pending plan change is not moving to an offer. type: string newPendingOffer: description: 'The name of the offer the entitlement is switching to upon a pending plan change. Only exists if the pending plan change is moving to an offer. Format: ''projects/{project}/services/{service}/privateOffers/{offer-id}'' OR ''projects/{project}/services/{service}/standardOffers/{offer-id}'', depending on whether the offer is private or public.' type: string newPendingOfferDuration: description: 'The offer duration of the new offer in ISO 8601 duration format. Field is empty if the pending plan change is not moving to an offer since the entitlement is not pending, only the plan change is pending.' type: string newPendingPlan: description: The identifier of the pending new plan. Required if the product has plans and the entitlement has a pending plan change. type: string newPlan: description: When the buyer changes plan, For Marketplace pub/sub event. type: string offer: description: 'The name of the offer that was procured. Field is empty if order was not made using an offer. Format: ''projects/{project}/services/{service}/privateOffers/{offer-id}'' OR ''projects/{project}/services/{service}/standardOffers/{offer-id}'', depending on whether the offer is private or public.' type: string offerDuration: description: 'The offer duration of the current offer in ISO 8601 duration format. Field is empty if entitlement was not made using an offer, such as "P1Y", "P2M"' type: string offerEffectiveTime: description: When the offer is effective. format: date-time type: string offerEndTime: description: 'Output only. End time for the Offer association corresponding to this entitlement. The field is only populated if the entitlement is currently associated with an Offer.' format: date-time type: string plan: description: The identifier of the plan that was procured. Required if the product has plans. type: string product: description: 'The identifier of the entity that was purchased. This may actually represent a product, quote, or offer. For Private offer, "projects/project-id/services/product-id.endpoints.partner-id.cloud.goog/privateOffers/private-offer-id"' type: string productExternalName: description: The identifier of the product that was procured. type: string provider: description: The ID of the service provider under Cloud Commerce platform that this entitlement was created against. type: string quoteExternalName: description: The identifier of the quote that was used to procure, such as the private offer Id. Empty if the order is not purchased using a quote. type: string state: allOf: - $ref: '#/components/schemas/GcpMarketplaceEntitlementState' description: Enums of the Entitlement State. https://cloud.google.com/marketplace/docs/partners/commerce-procurement-api/reference/rest/v1/providers.entitlements#EntitlementState type: object subscriptionEndTime: description: The End time for the subscription corresponding to this entitlement. format: date-time type: string updateTime: description: The last update timestamp. It is the endTime for the cancelled entitlement. format: date-time type: string usageReportingId: description: 'The consumerId to use when reporting usage through the Service Control API. See the consumerId field at Reporting Metrics (https://cloud.google.com/service-control/reporting-metrics) for more details. This field is present only if the product has usage-based billing configured.' type: string type: object GcpMarketplaceEntitlementState: enum: - ENTITLEMENT_STATE_UNSPECIFIED - ENTITLEMENT_ACTIVATION_REQUESTED - ENTITLEMENT_ACTIVE - ENTITLEMENT_PENDING_CANCELLATION - ENTITLEMENT_CANCELLED - ENTITLEMENT_PENDING_PLAN_CHANGE - ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL - ENTITLEMENT_SUSPENDED type: string x-enum-varnames: - GcpMarketplaceEntitlementState_ENTITLEMENT_STATE_UNSPECIFIED - GcpMarketplaceEntitlementState_ENTITLEMENT_ACTIVATION_REQUESTED - GcpMarketplaceEntitlementState_ENTITLEMENT_ACTIVE - GcpMarketplaceEntitlementState_ENTITLEMENT_PENDING_CANCELLATION - GcpMarketplaceEntitlementState_ENTITLEMENT_CANCELLED - GcpMarketplaceEntitlementState_ENTITLEMENT_PENDING_PLAN_CHANGE - GcpMarketplaceEntitlementState_ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL - GcpMarketplaceEntitlementState_ENTITLEMENT_SUSPENDED GcpMarketplaceExistingOfferData: properties: entitlement: $ref: '#/components/schemas/GcpMarketplaceEntitlement' existingPriceModelType: $ref: '#/components/schemas/GcpMarketplacePrivateOfferPriceModelType' hasEntitlementChanged: type: boolean privateOffer: $ref: '#/components/schemas/GcpMarketplaceExistingPrivateOffer' standardOffer: type: object type: object GcpMarketplaceExistingPrivateOffer: properties: agreement: type: string customEula: $ref: '#/components/schemas/GcpMarketplaceDocument' installmentTimeline: $ref: '#/components/schemas/GcpMarketplacePrivateOfferInstallmentTimeline' name: description: GCP private offer resource name. type: string offerTerm: $ref: '#/components/schemas/GcpMarketplacePrivateOfferTerm' paymentSchedule: $ref: '#/components/schemas/PaymentScheduleType' priceModel: allOf: - $ref: '#/components/schemas/GcpMarketplacePrivateOfferPriceModel' description: Nill if the offer has payment installments. type: object serviceLevel: description: The Plan of the offer. type: string type: object GcpMarketplaceExternalGoogleLink: properties: uri: type: string type: object GcpMarketplaceIsvInfo: example: contactEmail: contactEmail contactName: contactName partnerAdvantageAccountLegalName: partnerAdvantageAccountLegalName partnerAdvantageId: partnerAdvantageId properties: contactEmail: type: string contactName: type: string partnerAdvantageAccountLegalName: type: string partnerAdvantageId: type: string type: object GcpMarketplaceMeteringMetricValue: properties: boolValue: description: 'BoolValue: A boolean value.' type: boolean doubleValue: description: 'DoubleValue: A double precision floating point value.' type: number endTime: description: 'EndTime: The end of the time period over which this metric value''s measurement applies. If not specified, google.api.servicecontrol.v1.Operation.end_time will be used.' type: string int64Value: description: 'Int64Value: A signed 64-bit integer value.' example: '0' type: string labels: additionalProperties: type: string description: 'Labels: The labels describing the metric value. See comments on google.api.servicecontrol.v1.Operation.labels for the overriding relationship. Note that this map must not contain monitored resource labels.' type: object moneyValue: allOf: - $ref: '#/components/schemas/GcpMarketplaceMeteringMoney' description: 'MoneyValue: A money value.' type: object startTime: description: 'StartTime: The start of the time period over which this metric value''s measurement applies. The time period has different semantics for different metric types (cumulative, delta, and gauge). See the metric definition documentation in the service configuration for details. If not specified, google.api.servicecontrol.v1.Operation.start_time will be used.' type: string stringValue: description: 'StringValue: A text string value.' type: string type: object GcpMarketplaceMeteringMetricValueSet: properties: metricName: description: 'MetricName: The metric name defined in the service configuration.' type: string metricValues: description: 'MetricValues: The values in this metric.' items: $ref: '#/components/schemas/GcpMarketplaceMeteringMetricValue' type: array type: object GcpMarketplaceMeteringMoney: properties: currencyCode: description: 'CurrencyCode: The three-letter currency code defined in ISO 4217.' type: string nanos: description: 'Nanos: Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.' type: integer units: description: 'Units: The whole units of the amount. For example if `currencyCode` is "USD", then 1 unit is one US dollar.' example: '0' type: string type: object GcpMarketplaceMeteringOperation: properties: consumerId: description: 'ConsumerId: Identity of the consumer who is using the service. This field should be filled in for the operations initiated by a consumer, but not for service-initiated operations that are not related to a specific consumer. - This can be in one of the following formats: - project:PROJECT_ID, - project`_`number:PROJECT_NUMBER, - projects/PROJECT_ID or PROJECT_NUMBER, - folders/FOLDER_NUMBER, - organizations/ORGANIZATION_NUMBER, - api`_`key:API_KEY.' type: string endTime: description: 'EndTime: End time of the operation. Required when the operation is used in ServiceController.Report, but optional when the operation is used in ServiceController.Check.' type: string labels: additionalProperties: type: string description: 'Labels: Labels describing the operation. Only the following labels are allowed: - Labels describing monitored resources as defined in the service configuration. - Default labels of metric values. When specified, labels defined in the metric value override these default. - The following labels defined by Google Cloud Platform: - `cloud.googleapis.com/location` describing the location where the operation happened, - `servicecontrol.googleapis.com/user_agent` describing the user agent of the API request, - `servicecontrol.googleapis.com/service_agent` describing the service used to handle the API request (e.g. ESP), - `servicecontrol.googleapis.com/platform` describing the platform where the API is served, such as App Engine, Compute Engine, or Kubernetes Engine.' type: object metricValueSets: description: 'MetricValueSets: Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition. Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error.' items: $ref: '#/components/schemas/GcpMarketplaceMeteringMetricValueSet' type: array operationId: description: 'OperationId: Identity of the operation. This must be unique within the scope of the service that generated the operation. If the service calls Check() and Report() on the same operation, the two calls should carry the same id. UUID version 4 is recommended, though not required. In scenarios where an operation is computed from existing information and an idempotent id is desirable for deduplication purpose, UUID version 5 is recommended. See RFC 4122 for details.' type: string operationName: description: 'OperationName: Fully qualified name of the operation. Reserved for future use.' type: string startTime: description: 'StartTime: Required. Start time of the operation.' type: string type: object GcpMarketplaceOfferDealType: enum: - OFFER_DEAL_TYPE_UNSPECIFIED - CHANNEL_SHIFT - MIGRATION - NATIVE_RENEWAL type: string x-enum-varnames: - GcpMarketplaceOfferDealTypeNew - GcpMarketplaceOfferDealTypeChannelShift - GcpMarketplaceOfferDealTypeMigration - GcpMarketplaceOfferDealTypeNativeRenewal GcpMarketplaceOfferProration: enum: - PRORATION_UNSPECIFIED - NOT_PRORATED_ANNIVERSARY_DATES - PRORATED type: string x-enum-varnames: - GcpMarketplaceOfferProration_UNSPECIFIED - GcpMarketplaceOfferProration_NO - GcpMarketplaceOfferProration_YES GcpMarketplaceOfferStartPolicy: enum: - '' - OFFER_START_POLICY_IMMEDIATE - OFFER_START_POLICY_SCHEDULED type: string x-enum-varnames: - GcpMarketplaceOfferStartPolicy_UNKNOWN - GcpMarketplaceOfferStartPolicy_IMMEDIATE - GcpMarketplaceOfferStartPolicy_SCHEDULED GcpMarketplaceOfferTemplatePolicies: example: allowScheduledStartDate: true allowAutoRenewal: true maxRenewalTimes: maxRenewalTimes offerDealType: OFFER_DEAL_TYPE_UNSPECIFIED proration: PRORATION_UNSPECIFIED properties: allowAutoRenewal: type: boolean allowScheduledStartDate: type: boolean maxRenewalTimes: description: such as "3" type: string offerDealType: $ref: '#/components/schemas/GcpMarketplaceOfferDealType' proration: $ref: '#/components/schemas/GcpMarketplaceOfferProration' type: object GcpMarketplacePriceModel: enum: - FREE - SUBSCRIPTION - USAGE - SUBSCRIPTION_PLUS_USAGE type: string x-enum-varnames: - GcpMarketplacePriceModel_FREE - GcpMarketplacePriceModel_SUBSCRIPTION - GcpMarketplacePriceModel_USAGE - GcpMarketplacePriceModel_SUBSCRIPTION_PLUS_USAGE GcpMarketplacePrivateOffer: properties: activeEntitlement: $ref: '#/components/schemas/GcpMarketplaceEntitlement' agencyEnabled: type: boolean agreement: description: 'The resource name of agreement(entitlement) In format of "projects/{projectNumber}/agreements/{agreementId}"' type: string agreementDocuments: $ref: '#/components/schemas/GcpMarketplaceAgreementDocument' cancelTime: format: date-time type: string customerInfo: $ref: '#/components/schemas/GcpMarketplacePrivateOfferCustomerInfo' existingOfferData: $ref: '#/components/schemas/GcpMarketplaceExistingOfferData' expireTime: format: date-time type: string features: items: $ref: '#/components/schemas/GcpMarketplaceProductFeatureValue' type: array installmentTimeline: $ref: '#/components/schemas/GcpMarketplacePrivateOfferInstallmentTimeline' lifecycleState: description: such as "PUBLISHED" type: string metricInformation: $ref: '#/components/schemas/GcpMarketplacePrivateOfferMetricInformation' migrationMetadata: $ref: '#/components/schemas/GcpMarketplacePrivateOfferMigrationMetadata' name: description: 'In format of "projects/{projectNumber}/services/{serviceName, such as service-name.endpoints.gcp-project-id.cloud.goog}/privateOffers/{privateOfferId}"' type: string offerId: description: GCP private offer ID type: string offerSource: description: such as "OFFER" or "RESOLD" (resold via channel partner) enum: - OFFER - RESOLD type: string offerState: $ref: '#/components/schemas/GcpMarketplacePrivateOfferState' offerTerm: $ref: '#/components/schemas/GcpMarketplacePrivateOfferTerm' offerTitle: description: The offer title in the GCP Marketplace. type: string offerTitleAutoGenerated: type: boolean paymentSchedule: allOf: - $ref: '#/components/schemas/PaymentScheduleType' description: such as "PREPAY" or "POSTPAY" type: object policies: allOf: - $ref: '#/components/schemas/GcpMarketplacePrivateOfferPolicies' description: The policies of the offer. type: object priceModel: allOf: - $ref: '#/components/schemas/GcpMarketplacePrivateOfferPriceModel' description: Nill if the offer has payment installments. type: object priceModelType: $ref: '#/components/schemas/GcpMarketplacePrivateOfferPriceModelType' privateOfferRevenueShare: allOf: - $ref: '#/components/schemas/GcpMarketplacePrivateOfferRevenueShare' description: Revenue share information for this private offer type: object providerCancellationInternalNote: type: string providerInfo: $ref: '#/components/schemas/GcpMarketplacePrivateOfferProviderInfo' providerInternalNote: type: string providerPublicNote: type: string purchaseChannel: $ref: '#/components/schemas/GcpMarketplacePurchaseChannel' purchaseTime: format: date-time type: string replacementMetadata: $ref: '#/components/schemas/GcpMarketplacePrivateOfferReplacementMetadata' resellerInfo: allOf: - $ref: '#/components/schemas/GcpMarketplaceResellerInfo' description: The info of the reseller who resold the offer and when OfferSource is "RESOLD". type: object serviceLevel: description: The Plan of the offer. type: string updateTime: format: date-time type: string useLegacyPartnerEula: type: boolean userLabels: items: type: string type: array type: object GcpMarketplacePrivateOfferCustomerInfo: properties: address: description: The address of the customer type: string contact: description: The contact name of the customer type: string email: description: The email address of the customer type: string organization: description: The company name of the customer type: string unverifiedBillingAccount: description: The GCP billing account ID of the customer type: string type: object GcpMarketplacePrivateOfferInstallment: properties: priceModel: $ref: '#/components/schemas/GcpMarketplacePrivateOfferPriceModel' startTime: format: date-time type: string type: object GcpMarketplacePrivateOfferInstallmentTimeline: properties: installments: items: $ref: '#/components/schemas/GcpMarketplacePrivateOfferInstallment' type: array type: object GcpMarketplacePrivateOfferMetricDetail: properties: displayName: description: such as "CPU" type: string parentCommerceService: description: in format of "projects/{projectNumber}/services/service-name.endpoints.gcp-project-id.cloud.goog" type: string skuId: description: such as "BC1B-6259-BF57" type: string tiers: description: Price tiers for this metric. items: $ref: '#/components/schemas/GcpPriceTier' type: array unitDescription: description: such as "minute" type: string type: object GcpMarketplacePrivateOfferMetricInformation: properties: metricDetails: items: $ref: '#/components/schemas/GcpMarketplacePrivateOfferMetricDetail' type: array type: object GcpMarketplacePrivateOfferMigrationMetadata: properties: inventoryFlavorExternalName: description: Plan name maybe with term suffix, such as "plan-name-P1Y" type: string productExternalName: description: in format of "product-service-id.endpoints.gcp-project-id.cloud.goog" type: string projectId: description: The GCP project ID of the GCP marketplace integration. type: string projectNumber: description: The GCP project number of the provider. type: string providerId: description: 'The GCP provider ID / partner ID of the GCP marketplace integration. In most cases, it is the same as the project ID. But it could be different.' type: string type: object GcpMarketplacePrivateOfferPolicies: properties: cancellationPolicy: description: The cancellation policy of the offer. type: string defaultRenewalPolicy: description: The default renewal policy of the offer. type: string downgradePolicy: description: The downgrade policy of the offer. type: string maxRenewalTimes: description: The max renewal times of the offer. type: string offerDealType: allOf: - $ref: '#/components/schemas/GcpMarketplaceOfferDealType' description: The offer deal type of the offer. type: object purchaseApproval: description: The purchase approval of the offer. type: string purchaseApprovalOverride: description: The purchase approval override of the offer. type: string type: object GcpMarketplacePrivateOfferPriceModel: properties: baseOffer: description: in format of "projects/{projectNumber}/services/service-name.endpoints.gcp-project-id.cloud.goog/standardOffers/base-offer-id" type: string commitment: $ref: '#/components/schemas/GcpMarketplacePrivateOfferPriceModelCommitment' fixedPrice: $ref: '#/components/schemas/GcpMarketplacePrivateOfferPriceModelFixed' oneTimeCredit: allOf: - $ref: '#/components/schemas/GcpPriceValue' description: The one time credit in amount of money type: object overage: $ref: '#/components/schemas/GcpMarketplacePrivateOfferPriceModelOverage' payg: allOf: - $ref: '#/components/schemas/GcpMarketplacePrivateOfferPriceModelPayg' description: Pay as you go. type: object previousCreditBalancePolicy: description: such as "PREVIOUS_CREDIT_BALANCE_POLICY_UNSPECIFIED" type: string type: object GcpMarketplacePrivateOfferPriceModelCommitment: properties: commitmentAmountPerPeriod: $ref: '#/components/schemas/GcpPriceValue' discount: $ref: '#/components/schemas/GcpMarketplacePrivateOfferPriceModelDiscount' period: $ref: '#/components/schemas/GcpPeriodDuration' type: object GcpMarketplacePrivateOfferPriceModelDiscount: properties: discountPercentage: allOf: - $ref: '#/components/schemas/GcpAmountUnit' description: 'such as {"units": "0", "nanos": 0} as no discount, or {"units": "10", "nanos": 0} as 10% off discount' type: object discountedPrice: allOf: - $ref: '#/components/schemas/GcpPriceValue' description: 'The discounted price of the private offer. If the discount is 10% off, and the original price is $100, then the discounted price is $90.' type: object type: object GcpMarketplacePrivateOfferPriceModelFixed: properties: discount: $ref: '#/components/schemas/GcpMarketplacePrivateOfferPriceModelDiscount' period: $ref: '#/components/schemas/GcpPeriodDuration' type: object GcpMarketplacePrivateOfferPriceModelOverage: properties: discount: $ref: '#/components/schemas/GcpMarketplacePrivateOfferPriceModelDiscount' skuDiscounts: description: 'TODO: need to define the type' items: type: object type: array type: object GcpMarketplacePrivateOfferPriceModelPayg: properties: discount: $ref: '#/components/schemas/GcpMarketplacePrivateOfferPriceModelDiscount' skuDiscounts: description: 'TODO: need to define the type' items: type: object type: array type: object GcpMarketplacePrivateOfferPriceModelType: enum: - '' - PRICE_MODEL_TYPE_UNSPECIFIED - CUD - FIXED_FEE - FIXED_FEE_WITH_OVERAGE - PAYG - PAYG_WITH_CUD type: string x-enum-varnames: - GcpMarketplacePrivateOfferPriceModelType_UNKNOWN - GcpMarketplacePrivateOfferPriceModelType_UNSPECIFIED - GcpMarketplacePrivateOfferPriceModelType_CUD - GcpMarketplacePrivateOfferPriceModelType_FIXED_FEE - GcpMarketplacePrivateOfferPriceModelType_FIXED_FEE_WITH_OVERAGE - GcpMarketplacePrivateOfferPriceModelType_PAYG - GcpMarketplacePrivateOfferPriceModelType_PAYG_WITH_CUD GcpMarketplacePrivateOfferProviderInfo: properties: creatorEmailAddress: description: The email address of who create the private offer in the provider. type: string salesContactEmail: description: The sales contact email of the provider. type: string salesContactName: description: The sales contact name of the provider. type: string type: object GcpMarketplacePrivateOfferReplacementMetadata: properties: cotermAlignment: type: string replacedOffer: description: 'The resource name of the private offer being replaced. in format of "projects/{projectNumber}/services/{productServiceName}/privateOffers/{privateOfferId}"' type: string replacedOfferEndTime: format: date-time type: string replacementPolicy: type: string type: object GcpMarketplacePrivateOfferRevenueShare: properties: autoRenewRevenueShare: $ref: '#/components/schemas/GcpMarketplaceRevenueShareValue' revenueShare: $ref: '#/components/schemas/GcpMarketplaceRevenueShareValue' revenueShareChanges: items: $ref: '#/components/schemas/GcpMarketplaceRevenueShareChange' type: array type: object GcpMarketplacePrivateOfferState: enum: - OFFER_ACTIVE - OFFER_ACTIVATING - OFFER_SCHEDULED - OFFER_ENTITLEMENT_ACCOUNT_PENDING - OFFER_PUBLISHED - OFFER_LAPSED - OFFER_EXPIRED - OFFER_CANCELLED - OFFER_UNAVAILABLE - OFFER_DRAFT type: string x-enum-varnames: - GcpMarketplacePrivateOfferState_OFFER_ACTIVE - GcpMarketplacePrivateOfferState_OFFER_ACTIVATING - GcpMarketplacePrivateOfferState_OFFER_SCHEDULED - GcpMarketplacePrivateOfferState_OFFER_ENTITLEMENT_ACCOUNT_PENDING - GcpMarketplacePrivateOfferState_OFFER_PUBLISHED - GcpMarketplacePrivateOfferState_OFFER_LAPSED - GcpMarketplacePrivateOfferState_OFFER_EXPIRED - GcpMarketplacePrivateOfferState_OFFER_CANCELLED - GcpMarketplacePrivateOfferState_OFFER_UNAVAILABLE - GcpMarketplacePrivateOfferState_OFFER_DRAFT GcpMarketplacePrivateOfferTerm: properties: enableScheduledStartTimes: type: boolean endTime: format: date-time type: string startPolicy: $ref: '#/components/schemas/GcpMarketplaceOfferStartPolicy' startTime: format: date-time type: string termDuration: $ref: '#/components/schemas/GcpPeriodDuration' type: object GcpMarketplacePrivateOfferTermDurationConstraint: example: defaultDuration: unit: MONTHLY_PERIOD count: 9 properties: defaultDuration: $ref: '#/components/schemas/GcpPeriodDuration' type: object GcpMarketplacePrivateOfferTermTemplate: example: paymentRecurrence: paymentRecurrence termDurationConstraint: defaultDuration: unit: MONTHLY_PERIOD count: 9 startPolicy: '' startTime: 2000-01-23 04:56:07+00:00 endTime: 2000-01-23 04:56:07+00:00 enableScheduledStartTimes: true termDuration: unit: MONTHLY_PERIOD count: 9 properties: enableScheduledStartTimes: type: boolean endTime: format: date-time type: string paymentRecurrence: type: string startPolicy: $ref: '#/components/schemas/GcpMarketplaceOfferStartPolicy' startTime: format: date-time type: string termDuration: $ref: '#/components/schemas/GcpPeriodDuration' termDurationConstraint: $ref: '#/components/schemas/GcpMarketplacePrivateOfferTermDurationConstraint' type: object GcpMarketplaceProduct: example: revisionId: revisionId marketplace: marketplaces/google-cloud serviceConfig: name: name producerProjectId: producerProjectId metrics: - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 displayUnitDescription: displayUnitDescription unit: unit metricKind: metricKind displayName: displayName valueType: '{}' name: name description: description displayUnit: displayUnit id: id reportingUnit: reportingUnit skuId: skuId - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 displayUnitDescription: displayUnitDescription unit: unit metricKind: metricKind displayName: displayName valueType: '{}' name: name description: description displayUnit: displayUnit id: id reportingUnit: reportingUnit skuId: skuId title: title billing: metrics: - metrics - metrics createTime: 2000-01-23 04:56:07+00:00 service: service listingSpec: marketingSpec: signupUri: signupUri externalLicenseSpecs: - description: description uri: uri - description: description uri: uri searchKeywords: - searchKeywords - searchKeywords tagLine: tagLine displayNames: - displayNames - displayNames externalMarketingUrl: externalMarketingUrl icon: icon description: description searchCategories: - searchCategories - searchCategories searchDescription: searchDescription title: title supportSpec: description: description uri: uri email: email eulaUrl: eulaUrl documentationSpecs: - description: description title: title uri: uri - description: description title: title uri: uri purchaseSpec: features: - name: name description: description title: title - name: name description: description title: title purchaseOptionSpecs: - priceInfo: usageFees: - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 subscriptionPlans: - period: period price: nanos: 1 units: units currencyCode: currencyCode - period: period price: nanos: 1 units: units currencyCode: currencyCode description: description priceModel: FREE purchaseMode: PURCHASE_MODE_PRIVATE name: name title: title featureValues: - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription - priceInfo: usageFees: - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 subscriptionPlans: - period: period price: nanos: 1 units: units currencyCode: currencyCode - period: period price: nanos: 1 units: units currencyCode: currencyCode description: description priceModel: FREE purchaseMode: PURCHASE_MODE_PRIVATE name: name title: title featureValues: - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription metrics: - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 displayUnitDescription: displayUnitDescription unit: unit metricKind: metricKind displayName: displayName valueType: '{}' name: name description: description displayUnit: displayUnit id: id reportingUnit: reportingUnit skuId: skuId - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 displayUnitDescription: displayUnitDescription unit: unit metricKind: metricKind displayName: displayName valueType: '{}' name: name description: description displayUnit: displayUnit id: id reportingUnit: reportingUnit skuId: skuId listingType: BillingIntegratedManagedService termsSpec: standardEula: '{}' inlineEula: '{}' eulaUri: eulaUri externalAccountSpec: signupUri: signupUri loginUri: loginUri singleSignOnUri: singleSignOnUri name: name validationSummary: '{}' lastPublishTime: 2000-01-23 04:56:07+00:00 derivedDiscoveryState: accessState: ALLUSERS_ACCESSIBLE searchState: ADMIN_OVERRIDE_UNSEARCHABLE id: id revisionCreateTime: 2000-01-23 04:56:07+00:00 properties: createTime: format: date-time type: string derivedDiscoveryState: $ref: '#/components/schemas/GcpMarketplaceProductDerivedDiscoveryState' id: description: Nullable, GCP Marketplace Product UUID type: string lastPublishTime: format: date-time type: string listingSpec: $ref: '#/components/schemas/GcpMarketplaceProductListingSpec' marketplace: enum: - marketplaces/google-cloud type: string name: description: In format of "projects/{project-number}/listings/{product-name}.endpoints.{provider-id}.cloud.goog" type: string revisionCreateTime: format: date-time type: string revisionId: type: string service: description: In format of "services/{product-name}.endpoints.{provider-id}.cloud.goog" type: string serviceConfig: $ref: '#/components/schemas/GcpMarketplaceProductServiceConfig' validationSummary: description: 'TODO: add type' type: object type: object GcpMarketplaceProductAccessState: enum: - ALLUSERS_ACCESSIBLE - NOT_ALLUSERS_ACCESSIBLE - NOT_PUBLISHED type: string x-enum-varnames: - GcpMarketplaceProductAccessState_ALLUSERS_ACCESSIBLE - GcpMarketplaceProductAccessState_NOT_ALLUSERS_ACCESSIBLE - GcpMarketplaceProductAccessState_NOT_PUBLISHED GcpMarketplaceProductDerivedDiscoveryState: example: accessState: ALLUSERS_ACCESSIBLE searchState: ADMIN_OVERRIDE_UNSEARCHABLE properties: accessState: $ref: '#/components/schemas/GcpMarketplaceProductAccessState' searchState: enum: - ADMIN_OVERRIDE_UNSEARCHABLE - SEARCHABLE type: string type: object GcpMarketplaceProductDocumentationSpec: example: description: description title: title uri: uri properties: description: type: string title: type: string uri: type: string type: object GcpMarketplaceProductExternalAccountSpec: example: signupUri: signupUri loginUri: loginUri singleSignOnUri: singleSignOnUri properties: loginUri: type: string signupUri: type: string singleSignOnUri: type: string type: object GcpMarketplaceProductFeature: example: name: name description: description title: title properties: description: type: string name: type: string title: type: string type: object GcpMarketplaceProductFeatureValue: example: featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription properties: featureDescription: description: such as "CPU per VM" type: string featureName: description: such as "cpu" type: string featureTitle: description: such as "CPU" type: string featureValue: description: such as "2 CPU per VM" type: string type: object GcpMarketplaceProductInfo: example: flavorExternalName: flavorExternalName providerId: providerId serviceLevel: serviceLevel serviceName: serviceName productExternalName: productExternalName properties: flavorExternalName: description: The service level (price plan) with time duration suffix, such as "basic-plan-P1Y" type: string productExternalName: type: string providerId: type: string serviceLevel: description: The price plan, such as "basic-plan" type: string serviceName: type: string type: object GcpMarketplaceProductLicenseSpec: example: description: description uri: uri properties: description: type: string uri: type: string type: object GcpMarketplaceProductListingSpec: example: marketingSpec: signupUri: signupUri externalLicenseSpecs: - description: description uri: uri - description: description uri: uri searchKeywords: - searchKeywords - searchKeywords tagLine: tagLine displayNames: - displayNames - displayNames externalMarketingUrl: externalMarketingUrl icon: icon description: description searchCategories: - searchCategories - searchCategories searchDescription: searchDescription title: title supportSpec: description: description uri: uri email: email eulaUrl: eulaUrl documentationSpecs: - description: description title: title uri: uri - description: description title: title uri: uri purchaseSpec: features: - name: name description: description title: title - name: name description: description title: title purchaseOptionSpecs: - priceInfo: usageFees: - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 subscriptionPlans: - period: period price: nanos: 1 units: units currencyCode: currencyCode - period: period price: nanos: 1 units: units currencyCode: currencyCode description: description priceModel: FREE purchaseMode: PURCHASE_MODE_PRIVATE name: name title: title featureValues: - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription - priceInfo: usageFees: - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 subscriptionPlans: - period: period price: nanos: 1 units: units currencyCode: currencyCode - period: period price: nanos: 1 units: units currencyCode: currencyCode description: description priceModel: FREE purchaseMode: PURCHASE_MODE_PRIVATE name: name title: title featureValues: - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription metrics: - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 displayUnitDescription: displayUnitDescription unit: unit metricKind: metricKind displayName: displayName valueType: '{}' name: name description: description displayUnit: displayUnit id: id reportingUnit: reportingUnit skuId: skuId - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 displayUnitDescription: displayUnitDescription unit: unit metricKind: metricKind displayName: displayName valueType: '{}' name: name description: description displayUnit: displayUnit id: id reportingUnit: reportingUnit skuId: skuId listingType: BillingIntegratedManagedService termsSpec: standardEula: '{}' inlineEula: '{}' eulaUri: eulaUri externalAccountSpec: signupUri: signupUri loginUri: loginUri singleSignOnUri: singleSignOnUri properties: externalAccountSpec: $ref: '#/components/schemas/GcpMarketplaceProductExternalAccountSpec' listingType: enum: - BillingIntegratedManagedService type: string marketingSpec: $ref: '#/components/schemas/GcpMarketplaceProductMarketingSpec' purchaseSpec: $ref: '#/components/schemas/GcpMarketplaceProductPurchaseSpec' termsSpec: $ref: '#/components/schemas/GcpMarketplaceProductTermsSpec' type: object GcpMarketplaceProductMarketingSpec: example: signupUri: signupUri externalLicenseSpecs: - description: description uri: uri - description: description uri: uri searchKeywords: - searchKeywords - searchKeywords tagLine: tagLine displayNames: - displayNames - displayNames externalMarketingUrl: externalMarketingUrl icon: icon description: description searchCategories: - searchCategories - searchCategories searchDescription: searchDescription title: title supportSpec: description: description uri: uri email: email eulaUrl: eulaUrl documentationSpecs: - description: description title: title uri: uri - description: description title: title uri: uri properties: description: type: string displayNames: items: type: string type: array documentationSpecs: items: $ref: '#/components/schemas/GcpMarketplaceProductDocumentationSpec' type: array eulaUrl: type: string externalLicenseSpecs: items: $ref: '#/components/schemas/GcpMarketplaceProductLicenseSpec' type: array externalMarketingUrl: type: string icon: description: in format of "base64://..." type: string searchCategories: items: type: string type: array searchDescription: type: string searchKeywords: items: type: string type: array signupUri: type: string supportSpec: $ref: '#/components/schemas/GcpMarketplaceProductSupportSpec' tagLine: type: string title: type: string type: object GcpMarketplaceProductMeteringMetric: example: priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 displayUnitDescription: displayUnitDescription unit: unit metricKind: metricKind displayName: displayName valueType: '{}' name: name description: description displayUnit: displayUnit id: id reportingUnit: reportingUnit skuId: skuId properties: description: description: 'Description: A detailed description of the metric, which can be used in documentation.' type: string displayName: type: string displayUnit: description: such as "min" type: string displayUnitDescription: description: such as "minute" type: string id: description: 'The usage metering metric/dimension key It is in format of "{plan_id}_{usage_dimension_key}". For example, "basic_plan_storage".' type: string metricKind: description: such as "DELTA" type: string name: description: 'Name: The resource name of the metric descriptor, in format of "{productServiceName}/{plan_id}_{usage_dimension_key}"' type: string priceTiers: description: 'Price info of this usage metering metric. Only applicable for the default offer (plan) and private offer.' items: $ref: '#/components/schemas/GcpPriceTier' type: array reportingUnit: description: such as "min" type: string skuId: description: The SKU ID of this usage metering metric. Applicable only in Private Offer. type: string unit: description: such as "min" type: string valueType: allOf: - $ref: '#/components/schemas/ValueType' description: such as "INT64" type: object type: object GcpMarketplaceProductPriceInfo: example: usageFees: - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 subscriptionPlans: - period: period price: nanos: 1 units: units currencyCode: currencyCode - period: period price: nanos: 1 units: units currencyCode: currencyCode description: description priceModel: FREE properties: description: type: string priceModel: $ref: '#/components/schemas/GcpMarketplacePriceModel' subscriptionPlans: description: Subscription Plan (Flat Commitment) items: $ref: '#/components/schemas/GcpMarketplaceProductSubscriptionPlan' type: array usageFees: description: Usage Metering Dimension/Metric if available items: $ref: '#/components/schemas/GcpMarketplaceProductUsageFee' type: array type: object GcpMarketplaceProductPurchaseOptionSpec: example: priceInfo: usageFees: - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 subscriptionPlans: - period: period price: nanos: 1 units: units currencyCode: currencyCode - period: period price: nanos: 1 units: units currencyCode: currencyCode description: description priceModel: FREE purchaseMode: PURCHASE_MODE_PRIVATE name: name title: title featureValues: - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription properties: featureValues: items: $ref: '#/components/schemas/GcpMarketplaceProductFeatureValue' type: array name: description: The plan ID, such as "starter", without the duration suffix, such as "P1Y". type: string priceInfo: $ref: '#/components/schemas/GcpMarketplaceProductPriceInfo' purchaseMode: enum: - PURCHASE_MODE_PRIVATE - PURCHASE_MODE_PUBLIC type: string title: description: such as "Starter" type: string type: object GcpMarketplaceProductPurchaseSpec: example: features: - name: name description: description title: title - name: name description: description title: title purchaseOptionSpecs: - priceInfo: usageFees: - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 subscriptionPlans: - period: period price: nanos: 1 units: units currencyCode: currencyCode - period: period price: nanos: 1 units: units currencyCode: currencyCode description: description priceModel: FREE purchaseMode: PURCHASE_MODE_PRIVATE name: name title: title featureValues: - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription - priceInfo: usageFees: - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 subscriptionPlans: - period: period price: nanos: 1 units: units currencyCode: currencyCode - period: period price: nanos: 1 units: units currencyCode: currencyCode description: description priceModel: FREE purchaseMode: PURCHASE_MODE_PRIVATE name: name title: title featureValues: - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription metrics: - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 displayUnitDescription: displayUnitDescription unit: unit metricKind: metricKind displayName: displayName valueType: '{}' name: name description: description displayUnit: displayUnit id: id reportingUnit: reportingUnit skuId: skuId - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 displayUnitDescription: displayUnitDescription unit: unit metricKind: metricKind displayName: displayName valueType: '{}' name: name description: description displayUnit: displayUnit id: id reportingUnit: reportingUnit skuId: skuId properties: features: items: $ref: '#/components/schemas/GcpMarketplaceProductFeature' type: array metrics: description: GCP Marketplace Product Usage Metering Dimension/Metric items: $ref: '#/components/schemas/GcpMarketplaceProductMeteringMetric' type: array purchaseOptionSpecs: description: GCP Marketplace Product Pricing Plans items: $ref: '#/components/schemas/GcpMarketplaceProductPurchaseOptionSpec' type: array type: object GcpMarketplaceProductServiceConfig: example: name: name producerProjectId: producerProjectId metrics: - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 displayUnitDescription: displayUnitDescription unit: unit metricKind: metricKind displayName: displayName valueType: '{}' name: name description: description displayUnit: displayUnit id: id reportingUnit: reportingUnit skuId: skuId - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 displayUnitDescription: displayUnitDescription unit: unit metricKind: metricKind displayName: displayName valueType: '{}' name: name description: description displayUnit: displayUnit id: id reportingUnit: reportingUnit skuId: skuId title: title billing: metrics: - metrics - metrics properties: billing: $ref: '#/components/schemas/GcpMarketplaceProductServiceConfigBilling' metrics: items: $ref: '#/components/schemas/GcpMarketplaceProductMeteringMetric' type: array name: description: in format of "product-name.endpoints.gcp-project-id.cloud.goog" type: string producerProjectId: description: The GCP project ID of the producer. type: string title: description: The title of the product listing. type: string type: object GcpMarketplaceProductServiceConfigBilling: example: metrics: - metrics - metrics properties: metrics: description: 'The list of metrics that are available for billing for the product. In format of "product-name.endpoints.gcp-project-id.cloud.goog/plan_name_metric_name"' items: type: string type: array type: object GcpMarketplaceProductSubscriptionPlan: example: period: period price: nanos: 1 units: units currencyCode: currencyCode properties: period: description: such as "ONE_YEAR", "TWO_YEAR", "THREE_YEAR" type: string price: $ref: '#/components/schemas/GcpPriceValue' type: object GcpMarketplaceProductSupportSpec: example: description: description uri: uri email: email properties: description: type: string email: type: string uri: type: string type: object GcpMarketplaceProductTermsSpec: example: standardEula: '{}' inlineEula: '{}' eulaUri: eulaUri properties: eulaUri: type: string inlineEula: description: 'TODO: need to define the type' type: object standardEula: description: 'TODO: need to define the type' type: object type: object GcpMarketplaceProductUsageFee: example: priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 properties: displayQuantity: description: such as 1 type: integer metricId: description: such as "Starter_storage" type: string priceTiers: items: $ref: '#/components/schemas/GcpPriceTier' type: array type: object GcpMarketplacePurchaseChannel: properties: marketplace: type: boolean reseller: type: boolean type: object GcpMarketplaceResellerInfo: example: billingAccountOrgDisplayName: billingAccountOrgDisplayName resellerPrivateOfferPlanScope: resellerPrivateOfferPlanScope partnerAccountName: partnerAccountName notesToReseller: notesToReseller resellerContactName: resellerContactName resellOfferTemplateId: resellOfferTemplateId billingAccountId: billingAccountId billingAccountType: billingAccountType billingAccountNickname: billingAccountNickname resellerContactEmail: resellerContactEmail resellerPrivateOfferPlanId: resellerPrivateOfferPlanId subBillingAccount: subBillingAccount properties: billingAccountId: type: string billingAccountNickname: type: string billingAccountOrgDisplayName: type: string billingAccountType: type: string notesToReseller: type: string partnerAccountName: description: In the format of ""organizations/{GcpOrganizationID}/partnerAccounts/{partnerAccountID}" type: string resellOfferTemplateId: type: string resellerContactEmail: type: string resellerContactName: type: string resellerPrivateOfferPlanId: type: string resellerPrivateOfferPlanScope: type: string subBillingAccount: description: In the format of "billingAccounts/..." type: string type: object GcpMarketplaceResellerPrivateOfferPlan: example: offerTemplatePolicies: allowScheduledStartDate: true allowAutoRenewal: true maxRenewalTimes: maxRenewalTimes offerDealType: OFFER_DEAL_TYPE_UNSPECIFIED proration: PRORATION_UNSPECIFIED displayName: displayName agreementDocuments: isvToCustomerAgreementDocument: documentBody: documentBody documentType: documentType unstructuredDocument: content: content name: name description: description updateTime: 2000-01-23 04:56:07+00:00 externalGoogleLink: '{}' isvToResellerAgreementDocument: documentBody: documentBody documentType: documentType unstructuredDocument: content: content name: name description: description updateTime: 2000-01-23 04:56:07+00:00 externalGoogleLink: '{}' features: - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription isvInfo: contactEmail: contactEmail contactName: contactName partnerAdvantageAccountLegalName: partnerAdvantageAccountLegalName partnerAdvantageId: partnerAdvantageId paymentSchedule: '' installmentTimelineTemplate: installmentTemplates: - priceModelTemplate: baseOffer: baseOffer commitment: commitmentAmountPerPeriodTemplate: decimalAmountConstraint: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units currencyCode: currencyCode period: unit: MONTHLY_PERIOD count: 9 discountTemplate: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode consumption: overage payg: period: unit: MONTHLY_PERIOD count: 9 discountTemplate: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode skuDiscountTemplates: - '{}' - '{}' skuRepresentation: skuList: skus: - skus - skus skus: skus skuGroupList: '{}' subscription: fixedPrice fixedPrice: period: unit: MONTHLY_PERIOD count: 9 discountTemplate: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode overage: discountTemplate: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode skuDiscountTemplates: - '{}' - '{}' skuRepresentation: skuList: skus: - skus - skus skus: skus skuGroupList: '{}' startTime: 2000-01-23 04:56:07+00:00 - priceModelTemplate: baseOffer: baseOffer commitment: commitmentAmountPerPeriodTemplate: decimalAmountConstraint: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units currencyCode: currencyCode period: unit: MONTHLY_PERIOD count: 9 discountTemplate: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode consumption: overage payg: period: unit: MONTHLY_PERIOD count: 9 discountTemplate: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode skuDiscountTemplates: - '{}' - '{}' skuRepresentation: skuList: skus: - skus - skus skus: skus skuGroupList: '{}' subscription: fixedPrice fixedPrice: period: unit: MONTHLY_PERIOD count: 9 discountTemplate: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode overage: discountTemplate: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode skuDiscountTemplates: - '{}' - '{}' skuRepresentation: skuList: skus: - skus - skus skus: skus skuGroupList: '{}' startTime: 2000-01-23 04:56:07+00:00 state: cancellationReason: '{}' stateType: '' comment: comment rejectionReason: '{}' stateTransitions: - transitionTime: 2000-01-23 04:56:07+00:00 newState: stateType: null - transitionTime: 2000-01-23 04:56:07+00:00 newState: stateType: null reusePolicy: '' margin: marginPercentage: value: value agreement: agreement durationConfig: startTime: 2000-01-23 04:56:07+00:00 endTime: 2000-01-23 04:56:07+00:00 priceModelTemplate: '{}' startPolicy: '' updateTime: 2000-01-23 04:56:07+00:00 productInfo: flavorExternalName: flavorExternalName providerId: providerId serviceLevel: serviceLevel serviceName: serviceName productExternalName: productExternalName metaInfo: gcpOrganizationId: gcpOrganizationId gcpProjectNumber: gcpProjectNumber resellerInfo: billingAccountOrgDisplayName: billingAccountOrgDisplayName resellerPrivateOfferPlanScope: resellerPrivateOfferPlanScope partnerAccountName: partnerAccountName notesToReseller: notesToReseller resellerContactName: resellerContactName resellOfferTemplateId: resellOfferTemplateId billingAccountId: billingAccountId billingAccountType: billingAccountType billingAccountNickname: billingAccountNickname resellerContactEmail: resellerContactEmail resellerPrivateOfferPlanId: resellerPrivateOfferPlanId subBillingAccount: subBillingAccount name: name resellOfferTemplate: resellOfferTemplate replacementMetadata: '{}' acceptanceDeadlineTime: 2000-01-23 04:56:07+00:00 amendmentContext: '{}' offerTermTemplate: paymentRecurrence: paymentRecurrence termDurationConstraint: defaultDuration: unit: MONTHLY_PERIOD count: 9 startPolicy: '' startTime: 2000-01-23 04:56:07+00:00 endTime: 2000-01-23 04:56:07+00:00 enableScheduledStartTimes: true termDuration: unit: MONTHLY_PERIOD count: 9 properties: acceptanceDeadlineTime: format: date-time type: string agreement: description: 'The resource name of agreement(entitlement) In format of "projects/{projectNumber}/agreements/{agreementId}"' type: string agreementDocuments: $ref: '#/components/schemas/GcpMarketplaceResellerPrivateOfferPlanAgreementDocuments' amendmentContext: type: object displayName: type: string durationConfig: $ref: '#/components/schemas/GcpMarketplaceResellerPrivateOfferPlanDurationConfig' features: items: $ref: '#/components/schemas/GcpMarketplaceProductFeatureValue' type: array installmentTimelineTemplate: $ref: '#/components/schemas/GcpMarketplaceResellerPrivateOfferPlanInstallmentTimelineTemplate' isvInfo: $ref: '#/components/schemas/GcpMarketplaceIsvInfo' margin: $ref: '#/components/schemas/GcpMarketplaceResellerPrivateOfferPlanMargin' metaInfo: $ref: '#/components/schemas/GcpMarketplaceResellerPrivateOfferPlanMetainfo' name: description: In format of "projects/{projectNumber}/partnerAccounts/{partnerAccountId}/resellerPrivateOfferPlans/{resellerPrivateOfferPlanId}" type: string offerTemplatePolicies: $ref: '#/components/schemas/GcpMarketplaceOfferTemplatePolicies' offerTermTemplate: $ref: '#/components/schemas/GcpMarketplacePrivateOfferTermTemplate' paymentSchedule: $ref: '#/components/schemas/PaymentScheduleType' priceModelTemplate: allOf: - $ref: '#/components/schemas/GcpMarketplaceResellerPrivateOfferPlanPriceModelTemplate' description: Nill if this reseller private offer plan has installmentTimelineTemplate (payment installments). type: object productInfo: $ref: '#/components/schemas/GcpMarketplaceProductInfo' replacementMetadata: type: object resellOfferTemplate: description: in format of "resellOfferTemplates/{resellOfferTemplateId}" type: string resellerInfo: $ref: '#/components/schemas/GcpMarketplaceResellerInfo' reusePolicy: $ref: '#/components/schemas/GcpMarketplaceResellerPrivateOfferPlanReusePolicy' startPolicy: $ref: '#/components/schemas/GcpMarketplaceStartPolicy' state: $ref: '#/components/schemas/GcpMarketplaceResellerPrivateOfferPlanState' stateTransitions: items: $ref: '#/components/schemas/GcpMarketplaceResellerPrivateOfferPlanStateTransition' type: array updateTime: format: date-time type: string type: object GcpMarketplaceResellerPrivateOfferPlanAgreementDocuments: example: isvToCustomerAgreementDocument: documentBody: documentBody documentType: documentType unstructuredDocument: content: content name: name description: description updateTime: 2000-01-23 04:56:07+00:00 externalGoogleLink: '{}' isvToResellerAgreementDocument: documentBody: documentBody documentType: documentType unstructuredDocument: content: content name: name description: description updateTime: 2000-01-23 04:56:07+00:00 externalGoogleLink: '{}' properties: isvToCustomerAgreementDocument: $ref: '#/components/schemas/GcpMarketplaceDocument' isvToResellerAgreementDocument: $ref: '#/components/schemas/GcpMarketplaceDocument' type: object GcpMarketplaceResellerPrivateOfferPlanDurationConfig: example: startTime: 2000-01-23 04:56:07+00:00 endTime: 2000-01-23 04:56:07+00:00 properties: endTime: format: date-time type: string startTime: format: date-time type: string type: object GcpMarketplaceResellerPrivateOfferPlanInstallmentTemplate: example: priceModelTemplate: baseOffer: baseOffer commitment: commitmentAmountPerPeriodTemplate: decimalAmountConstraint: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units currencyCode: currencyCode period: unit: MONTHLY_PERIOD count: 9 discountTemplate: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode consumption: overage payg: period: unit: MONTHLY_PERIOD count: 9 discountTemplate: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode skuDiscountTemplates: - '{}' - '{}' skuRepresentation: skuList: skus: - skus - skus skus: skus skuGroupList: '{}' subscription: fixedPrice fixedPrice: period: unit: MONTHLY_PERIOD count: 9 discountTemplate: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode overage: discountTemplate: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode skuDiscountTemplates: - '{}' - '{}' skuRepresentation: skuList: skus: - skus - skus skus: skus skuGroupList: '{}' startTime: 2000-01-23 04:56:07+00:00 properties: priceModelTemplate: $ref: '#/components/schemas/GcpMarketplaceResellerPrivateOfferPlanPriceModelTemplate' startTime: format: date-time type: string type: object GcpMarketplaceResellerPrivateOfferPlanInstallmentTimelineTemplate: example: installmentTemplates: - priceModelTemplate: baseOffer: baseOffer commitment: commitmentAmountPerPeriodTemplate: decimalAmountConstraint: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units currencyCode: currencyCode period: unit: MONTHLY_PERIOD count: 9 discountTemplate: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode consumption: overage payg: period: unit: MONTHLY_PERIOD count: 9 discountTemplate: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode skuDiscountTemplates: - '{}' - '{}' skuRepresentation: skuList: skus: - skus - skus skus: skus skuGroupList: '{}' subscription: fixedPrice fixedPrice: period: unit: MONTHLY_PERIOD count: 9 discountTemplate: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode overage: discountTemplate: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode skuDiscountTemplates: - '{}' - '{}' skuRepresentation: skuList: skus: - skus - skus skus: skus skuGroupList: '{}' startTime: 2000-01-23 04:56:07+00:00 - priceModelTemplate: baseOffer: baseOffer commitment: commitmentAmountPerPeriodTemplate: decimalAmountConstraint: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units currencyCode: currencyCode period: unit: MONTHLY_PERIOD count: 9 discountTemplate: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode consumption: overage payg: period: unit: MONTHLY_PERIOD count: 9 discountTemplate: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode skuDiscountTemplates: - '{}' - '{}' skuRepresentation: skuList: skus: - skus - skus skus: skus skuGroupList: '{}' subscription: fixedPrice fixedPrice: period: unit: MONTHLY_PERIOD count: 9 discountTemplate: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode overage: discountTemplate: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode skuDiscountTemplates: - '{}' - '{}' skuRepresentation: skuList: skus: - skus - skus skus: skus skuGroupList: '{}' startTime: 2000-01-23 04:56:07+00:00 properties: installmentTemplates: items: $ref: '#/components/schemas/GcpMarketplaceResellerPrivateOfferPlanInstallmentTemplate' type: array type: object GcpMarketplaceResellerPrivateOfferPlanMargin: example: marginPercentage: value: value properties: marginPercentage: $ref: '#/components/schemas/GcpMarketplaceResellerPrivateOfferPlanMarginPercentage' type: object GcpMarketplaceResellerPrivateOfferPlanMarginPercentage: example: value: value properties: value: description: The percentage value of the margin in the range of 0 to 100. type: string type: object GcpMarketplaceResellerPrivateOfferPlanMetainfo: example: gcpOrganizationId: gcpOrganizationId gcpProjectNumber: gcpProjectNumber properties: gcpOrganizationId: description: Gcp Organiztion ID from integration with GCP Marketplace. type: string gcpProjectNumber: description: Gcp Project Number from integration with GCP Marketplace. type: string type: object GcpMarketplaceResellerPrivateOfferPlanNewState: example: stateType: null properties: stateType: $ref: '#/components/schemas/GcpMarketplaceResellerPrivateOfferPlanStateType' type: object GcpMarketplaceResellerPrivateOfferPlanPriceModelSkuList: example: skus: - skus - skus properties: skus: items: type: string type: array type: object GcpMarketplaceResellerPrivateOfferPlanPriceModelSkuRepresentation: example: skuList: skus: - skus - skus skus: skus skuGroupList: '{}' properties: skuGroupList: type: object skuList: $ref: '#/components/schemas/GcpMarketplaceResellerPrivateOfferPlanPriceModelSkuList' skus: type: string type: object GcpMarketplaceResellerPrivateOfferPlanPriceModelTemplate: example: baseOffer: baseOffer commitment: commitmentAmountPerPeriodTemplate: decimalAmountConstraint: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units currencyCode: currencyCode period: unit: MONTHLY_PERIOD count: 9 discountTemplate: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode consumption: overage payg: period: unit: MONTHLY_PERIOD count: 9 discountTemplate: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode skuDiscountTemplates: - '{}' - '{}' skuRepresentation: skuList: skus: - skus - skus skus: skus skuGroupList: '{}' subscription: fixedPrice fixedPrice: period: unit: MONTHLY_PERIOD count: 9 discountTemplate: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode overage: discountTemplate: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode skuDiscountTemplates: - '{}' - '{}' skuRepresentation: skuList: skus: - skus - skus skus: skus skuGroupList: '{}' properties: baseOffer: description: in format of "projects/{projectNumber}/services/service-name.endpoints.gcp-project-id.cloud.goog/standardOffers/base-offer-id" type: string commitment: $ref: '#/components/schemas/GcpMarketplaceResellerPrivateOfferPlanPriceModelTemplateCommitment' consumption: enum: - overage - payg type: string fixedPrice: $ref: '#/components/schemas/GcpMarketplaceResellerPrivateOfferPlanPriceModelTemplateFixedPrice' overage: $ref: '#/components/schemas/GcpMarketplaceResellerPrivateOfferPlanPriceModelTemplateOverage' payg: $ref: '#/components/schemas/GcpMarketplaceResellerPrivateOfferPlanPriceModelTemplatePayg' subscription: enum: - fixedPrice - commitment type: string type: object GcpMarketplaceResellerPrivateOfferPlanPriceModelTemplateCommitment: example: commitmentAmountPerPeriodTemplate: decimalAmountConstraint: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units currencyCode: currencyCode period: unit: MONTHLY_PERIOD count: 9 discountTemplate: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode properties: commitmentAmountPerPeriodTemplate: $ref: '#/components/schemas/GcpCommitmentAmountPerPeriodTemplate' discountTemplate: $ref: '#/components/schemas/GcpPriceModelDiscountTemplate' period: $ref: '#/components/schemas/GcpPeriodDuration' type: object GcpMarketplaceResellerPrivateOfferPlanPriceModelTemplateFixedPrice: example: period: unit: MONTHLY_PERIOD count: 9 discountTemplate: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode properties: discountTemplate: $ref: '#/components/schemas/GcpPriceModelDiscountTemplate' period: $ref: '#/components/schemas/GcpPeriodDuration' type: object GcpMarketplaceResellerPrivateOfferPlanPriceModelTemplateOverage: example: discountTemplate: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode skuDiscountTemplates: - '{}' - '{}' skuRepresentation: skuList: skus: - skus - skus skus: skus skuGroupList: '{}' properties: discountTemplate: $ref: '#/components/schemas/GcpPriceModelDiscountTemplate' skuDiscountTemplates: items: type: object type: array skuRepresentation: $ref: '#/components/schemas/GcpMarketplaceResellerPrivateOfferPlanPriceModelSkuRepresentation' type: object GcpMarketplaceResellerPrivateOfferPlanPriceModelTemplatePayg: example: period: unit: MONTHLY_PERIOD count: 9 discountTemplate: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode skuDiscountTemplates: - '{}' - '{}' skuRepresentation: skuList: skus: - skus - skus skus: skus skuGroupList: '{}' properties: discountTemplate: $ref: '#/components/schemas/GcpPriceModelDiscountTemplate' period: $ref: '#/components/schemas/GcpPeriodDuration' skuDiscountTemplates: items: type: object type: array skuRepresentation: $ref: '#/components/schemas/GcpMarketplaceResellerPrivateOfferPlanPriceModelSkuRepresentation' type: object GcpMarketplaceResellerPrivateOfferPlanReusePolicy: enum: - '' - REUSE_POLICY_SINGLE_USE - REUSE_POLICY_MULTI_USE type: string x-enum-varnames: - GcpMarketplaceResellerPrivateOfferPlanReusePolicy_UNKNOWN - GcpMarketplaceResellerPrivateOfferPlanReusePolicy_SINGLE_USE - GcpMarketplaceResellerPrivateOfferPlanReusePolicy_MULTI_USE GcpMarketplaceResellerPrivateOfferPlanState: example: cancellationReason: '{}' stateType: '' comment: comment rejectionReason: '{}' properties: cancellationReason: type: object comment: type: string rejectionReason: type: object stateType: $ref: '#/components/schemas/GcpMarketplaceResellerPrivateOfferPlanStateType' type: object GcpMarketplaceResellerPrivateOfferPlanStateTransition: example: transitionTime: 2000-01-23 04:56:07+00:00 newState: stateType: null properties: newState: $ref: '#/components/schemas/GcpMarketplaceResellerPrivateOfferPlanNewState' transitionTime: format: date-time type: string type: object GcpMarketplaceResellerPrivateOfferPlanStateType: enum: - '' - STATE_TYPE_DRAFT - STATE_TYPE_READY_TO_ACCEPT - STATE_TYPE_READY_TO_USE - STATE_TYPE_REJECTED - STATE_TYPE_USED - STATE_TYPE_CANCELED - STATE_TYPE_EXPIRED_NEVER_ACCEPTED - STATE_TYPE_EXPIRED_ACCEPTED - STATE_TYPE_COMPLETED type: string x-enum-varnames: - GcpMarketplaceResellerPrivateOfferPlanStateType_UNKNOWN - GcpMarketplaceResellerPrivateOfferPlanStateType_DRAFT - GcpMarketplaceResellerPrivateOfferPlanStateType_READY_TO_ACCEPT - GcpMarketplaceResellerPrivateOfferPlanStateType_READY_TO_USE - GcpMarketplaceResellerPrivateOfferPlanStateType_REJECTED - GcpMarketplaceResellerPrivateOfferPlanStateType_USED - GcpMarketplaceResellerPrivateOfferPlanStateType_CANCELED - GcpMarketplaceResellerPrivateOfferPlanStateType_EXPIRED_NEVER_ACCEPTED - GcpMarketplaceResellerPrivateOfferPlanStateType_EXPIRED_ACCEPTED - GcpMarketplaceResellerPrivateOfferPlanStateType_COMPLETED GcpMarketplaceRevenueShareChange: properties: revenueShare: $ref: '#/components/schemas/GcpMarketplaceRevenueShareValue' revenueShareType: $ref: '#/components/schemas/GcpMarketplaceRevenueShareType' startTime: type: string type: object GcpMarketplaceRevenueShareType: enum: - AUTOMATIC - MANUAL type: string x-enum-varnames: - GcpMarketplaceRevenueShareTypeAUTOMATIC - GcpMarketplaceRevenueShareTypeMANUAL GcpMarketplaceRevenueShareValue: properties: value: type: string type: object GcpMarketplaceStartPolicy: enum: - '' - START_POLICY_ON_ACCEPTANCE - START_POLICY_SCHEDULED type: string x-enum-varnames: - GcpMarketplaceStartPolicy_UNKNOWN - GcpMarketplaceStartPolicy_ON_ACCEPTANCE - GcpMarketplaceStartPolicy_SCHEDULED GcpMarketplaceUnstructuredDocument: example: content: content properties: content: type: string type: object GcpMarketplaceUsagePlanPriceModel: enum: - '' - CUD_LIST_PRICE - CUD_ALL_USAGE_DISCOUNTED - USAGE_DISCOUNT_ONLY type: string x-enum-varnames: - GcpMarketplaceUsagePlanPriceModel_UNKNOWN - GcpMarketplaceUsagePlanPriceModel_CUD_LIST_PRICE - GcpMarketplaceUsagePlanPriceModel_CUD_ALL_USAGE_DISCOUNTED - GcpMarketplaceUsagePlanPriceModel_USAGE_DISCOUNT_ONLY GcpMarketplaceUserAccount: properties: approvals: description: The approvals for this account, that are permitted or have been completed. items: $ref: '#/components/schemas/GcpMarketplaceUserAccountApproval' type: array billingAccountId: description: The buyer's GCP billing account ID if it's a company account. type: string createTime: description: RFC3339 UTC timestamp format: date-time type: string id: description: GCP Marketplace User Account ID. type: string inputProperties: items: type: integer type: array name: description: The resource name of the account, in format of providers/{provider_id}/accounts/{account_id}. type: string parentBillingAccountId: description: 'The parent account ID of the BillingAccountId if the buyer is from a reseller in GCP Marketplace. It is the GCP billing account ID of the reseller in GCP Marketplace.' type: string provider: description: The identifier of the service provider (SaaS Seller) that this account was created against. type: string state: allOf: - $ref: '#/components/schemas/GcpMarketplaceUserAccountState' description: The state of the account. An account might not be able to make a purchase if the billing account is suspended. type: object updateTime: description: RFC3339 UTC timestamp format: date-time type: string userInfo: $ref: '#/components/schemas/GcpUserInfo' type: object GcpMarketplaceUserAccountApproval: properties: name: type: string reason: description: An explanation for the state of the approval. type: string state: $ref: '#/components/schemas/GcpMarketplaceUserAccountApprovalState' updateTime: description: RFC3339 UTC timestamp type: string type: object GcpMarketplaceUserAccountApprovalState: enum: - STATE_UNSPECIFIED - PENDING - APPROVED - REJECTED type: string x-enum-varnames: - GcpMarketplaceUserAccountApprovalState_STATE_UNSPECIFIED - GcpMarketplaceUserAccountApprovalState_PENDING - GcpMarketplaceUserAccountApprovalState_APPROVED - GcpMarketplaceUserAccountApprovalState_REJECTED GcpMarketplaceUserAccountState: enum: - ACCOUNT_STATE_UNSPECIFIED - ACCOUNT_ACTIVE type: string x-enum-varnames: - GcpMarketplaceUserAccountState_UNSPECIFIED - GcpMarketplaceUserAccountState_ACTIVE GcpPeriodDuration: example: unit: MONTHLY_PERIOD count: 9 properties: count: description: such as 1, 6, 12 type: integer unit: $ref: '#/components/schemas/GcpPeriodDurationUnit' type: object GcpPeriodDurationUnit: enum: - MONTHLY_PERIOD - YEARLY_PERIOD type: string x-enum-varnames: - GcpPeriodDurationUnit_MONTHLY_PERIOD - GcpPeriodDurationUnit_YEARLY_PERIOD GcpPriceModelDiscountTemplate: example: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode properties: discountEconomics: type: string discountPercentage: $ref: '#/components/schemas/GcpAmountConstraint' discountedPrice: $ref: '#/components/schemas/GcpPriceValue' hideDiscountPercentage: type: boolean type: object GcpPriceTier: example: startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 properties: fromAmount: description: such as 0 type: number price: $ref: '#/components/schemas/GcpPriceValue' startingUsageAmount: description: such as "0" type: string type: object GcpPriceValue: example: nanos: 1 units: units currencyCode: currencyCode properties: currencyCode: description: such as "USD" type: string nanos: description: for the decimal part, such as 30000000 = $0.03 type: integer units: description: for the integer part, such as "500000" = $50K type: string type: object GcpUserInfo: properties: orders: description: 'a list of unique order IDs for each entitlement ID that indicates the different offers on the same product. This field is available only if multiple orders of the same product is enabled' items: type: string type: array roles: description: 'An array of strings representing the user''s roles. Right now, it can be either: ** account_admin, which indicates that the user is a Billing Account Administrator of the billing account that purchased the product, or ** project_editor, which indicates that the user is a Project Editor, but not a Billing Administrator, of the project under that billing account.' items: type: string type: array user_identity: description: The user's obfuscated GAIA ID, which can be used to initiate Open ID Connect. type: string type: object GetRevenueReportParams: example: organizationID: organizationID reportType: GrossAmount partner: AWS productID: productID service: MARKETPLACE entitlementID: entitlementID groupBy: '{}' buyerID: buyerID properties: buyerID: description: Optional, if available, return the report for the Buyer. type: string entitlementID: description: Optional, if available, return the report for the Entitlement. type: string groupBy: allOf: - $ref: '#/components/schemas/GroupByInterval' description: default:"day" type: object organizationID: description: Required. If the productID & entitlementID are emtpy, return the report for the entire Organization. type: string partner: enum: - AWS - AZURE - GCP type: string productID: description: Optional, if available, return the report for the Product. type: string reportType: $ref: '#/components/schemas/RevenueReportType' service: enum: - MARKETPLACE type: string required: - organizationID - partner - reportType - service type: object GroupByInterval: enum: - day - month type: string x-enum-varnames: - GroupByIntervalDay - GroupByIntervalMonth IdentityBuyer: example: organizationID: organizationID creationTime: 2000-01-23 04:56:07+00:00 partner: '' name: name description: description externalID: externalID id: id contactIds: - contactIds - contactIds info: stripeBuyer: '{}' invoicedAmount: 5.962133916683182 snowflakeBuyer: '{}' companyInfo: country: country emailDomain: emailDomain city: city postalCode: postalCode name: name addressLine1: addressLine1 addressLine2: addressLine2 state: state validFrom: validFrom gcpBuyer: '{}' lastModifiedBy: lastModifiedBy grossAmount: 1.4658129805029452 collectableAmount: 0.8008281904610115 paymentConfig: '{}' emailAddress: emailAddress orbCustomerId: orbCustomerId adyenBuyer: '{}' azureBuyer: '{}' customerId: customerId lagoCustomerId: lagoCustomerId awsBuyer: '{}' fields: key: '' metronomeCustomerId: metronomeCustomerId stripeCustomerId: stripeCustomerId disbursedAmount: 6.027456183070403 spaUrl: spaUrl lastUpdateTime: 2000-01-23 04:56:07+00:00 properties: contactIds: items: type: string type: array creationTime: format: date-time type: string description: type: string externalID: type: string id: type: string info: $ref: '#/components/schemas/BuyerInfo' lastUpdateTime: format: date-time type: string name: type: string organizationID: type: string partner: $ref: '#/components/schemas/Partner' type: object IdentityConctactInfo: example: phoneNumber: phoneNumber role: role companyName: companyName lastModifiedBy: lastModifiedBy companyLocation: companyLocation properties: companyLocation: type: string companyName: type: string lastModifiedBy: type: string phoneNumber: type: string role: type: string type: object IdentityContact: example: organizationID: organizationID emailAddress: emailAddress creationTime: creationTime name: name id: id info: phoneNumber: phoneNumber role: role companyName: companyName lastModifiedBy: lastModifiedBy companyLocation: companyLocation lastUpdateTime: lastUpdateTime properties: creationTime: type: string emailAddress: type: string id: description: This is generated by Suger. When you create a new contact, do not provide. type: string info: $ref: '#/components/schemas/IdentityConctactInfo' lastUpdateTime: type: string name: type: string organizationID: type: string type: object InvoiceAddFixedFee: example: reason: reason quantity: 0 endDate: 2000-01-23 04:56:07+00:00 rate: 6.027456183070403 startDate: 2000-01-23 04:56:07+00:00 properties: endDate: format: date-time type: string quantity: type: integer rate: type: number reason: type: string startDate: format: date-time type: string type: object InvoiceAdjustDiscountByDimension: example: reason: reason dimensionKey: dimensionKey discount: discountType: PERCENTAGE value: 1.4658129805029452 properties: dimensionKey: type: string discount: $ref: '#/components/schemas/BillingDiscount' reason: type: string type: object InvoiceAdjustMinimumSpendByDimension: example: minimumSpend: 5.962133916683182 reason: reason dimensionKey: dimensionKey properties: dimensionKey: type: string minimumSpend: type: number reason: type: string type: object InvoiceAdjustOverallDiscount: properties: discount: $ref: '#/components/schemas/BillingDiscount' reason: type: string type: object InvoiceAdjustOverallMinimumSpend: properties: minimumSpend: type: number reason: type: string type: object LastModifiedBy: properties: email: description: The email of the creator. type: string entityId: description: The ID of the creator. type: string entityType: allOf: - $ref: '#/components/schemas/EntityType' description: The Entity type of the creator, either USER or API_CLIENT. type: object name: description: The name of the creator. type: string type: object ListNotificationEventsResponse: example: nextOffset: 0 totalCount: 6 notificationEvents: - eventID: eventID customFields: key: '' entityType: '' contactEmails: - contactEmails - contactEmails entityID: entityID message: message priority: '{}' title: title contactIds: - contactIds - contactIds organizationID: organizationID ccContactIds: - ccContactIds - ccContactIds channels: - EMAIL - EMAIL isActionItem: true partner: '{}' createdBy: '{}' entityStatus: entityStatus entityName: entityName eventStatus: '{}' action: '' requireAudit: true trackEvents: - contactId: contactId action: OPEN_EMAIL timestamp: 2000-01-23 04:56:07+00:00 - contactId: contactId action: OPEN_EMAIL timestamp: 2000-01-23 04:56:07+00:00 info: '{}' lastUpdateTime: 2000-01-23 04:56:07+00:00 timestamp: 2000-01-23 04:56:07+00:00 - eventID: eventID customFields: key: '' entityType: '' contactEmails: - contactEmails - contactEmails entityID: entityID message: message priority: '{}' title: title contactIds: - contactIds - contactIds organizationID: organizationID ccContactIds: - ccContactIds - ccContactIds channels: - EMAIL - EMAIL isActionItem: true partner: '{}' createdBy: '{}' entityStatus: entityStatus entityName: entityName eventStatus: '{}' action: '' requireAudit: true trackEvents: - contactId: contactId action: OPEN_EMAIL timestamp: 2000-01-23 04:56:07+00:00 - contactId: contactId action: OPEN_EMAIL timestamp: 2000-01-23 04:56:07+00:00 info: '{}' lastUpdateTime: 2000-01-23 04:56:07+00:00 timestamp: 2000-01-23 04:56:07+00:00 properties: nextOffset: description: If it is nil, it means there is no more records. type: integer notificationEvents: items: $ref: '#/components/schemas/NotificationEvent' type: array totalCount: description: Only available when the request is made with offset=0. type: integer type: object ListNotificationMessagesResponse: example: notificationMessages: - organizationID: organizationID creationTime: 2000-01-23 04:56:07+00:00 recipient: recipient id: id type: EMAIL info: standardFields: key: '' customFields: key: '' subject: subject rccRecipients: - rccRecipients - rccRecipients ccRecipients: - ccRecipients - ccRecipients action: '{}' textContent: textContent htmlContent: htmlContent - organizationID: organizationID creationTime: 2000-01-23 04:56:07+00:00 recipient: recipient id: id type: EMAIL info: standardFields: key: '' customFields: key: '' subject: subject rccRecipients: - rccRecipients - rccRecipients ccRecipients: - ccRecipients - ccRecipients action: '{}' textContent: textContent htmlContent: htmlContent nextOffset: 0 totalCount: 6 properties: nextOffset: description: 'The next offset to use in the next request to get the next page of notification messages. If this field is null, there are no more notification messages to get.' type: integer notificationMessages: items: $ref: '#/components/schemas/NotificationMessage' type: array totalCount: description: 'The total number of notification messages. Only available when the request is made with the first offset = 0.' type: integer type: object ListRevenueRecordDetailsResponse: example: nextOffset: 0 revenueRecordDetails: - awsRevenueRecordDetail: '{}' gcpRevenueRecordDetail: '{}' azureRevenueRecordDetail: '{}' - awsRevenueRecordDetail: '{}' gcpRevenueRecordDetail: '{}' azureRevenueRecordDetail: '{}' properties: nextOffset: type: integer revenueRecordDetails: items: $ref: '#/components/schemas/RevenueRecordDetail' type: array type: object ListRevenueRecordsResponse: example: revenueRecords: - date: 2000-01-23 04:56:07+00:00 amount: 0.8008281904610115 productID: productID refundDisburseAmount: 9.965781217890562 entitlementID: entitlementID invoiceAmount: 5.025004791520295 buyerID: buyerID invoiceDate: 2000-01-23 04:56:07+00:00 collectableAmount: 6.027456183070403 disburseDate: 2000-01-23 04:56:07+00:00 refundInvoiceDate: 2000-01-23 04:56:07+00:00 refundDisburseDate: 2000-01-23 04:56:07+00:00 organizationID: organizationID paymentDueDate: 2000-01-23 04:56:07+00:00 refundInvoiceAmount: 9.369310271410669 partner: partner currency: currency disburseAmount: 1.4658129805029452 id: id taxAmount: 6.683562403749608 info: awsRevenueRecords: - brokerID: brokerID usagePeriodStartDate: valid: true time: time productID: productID insertDate: valid: true time: time toAccountID: toAccountID usagePeriodEndDate: valid: true time: time parentBillingEventID: parentBillingEventID disbursementBillingEventID: disbursementBillingEventID action: action offerID: offerID currency: currency invoiceID: invoiceID id: id balanceImpacting: 5 amount: 5.962133916683182 endUserAccountID: endUserAccountID dataFeedProductID: dataFeedProductID entitlementID: entitlementID buyerID: buyerID invoiceDate: valid: true time: time transactionReferenceID: transactionReferenceID organizationID: organizationID transactionType: transactionType paymentDueDate: valid: true time: time fromAccountID: fromAccountID agreementID: agreementID billingAddressID: billingAddressID bankTraceID: bankTraceID - brokerID: brokerID usagePeriodStartDate: valid: true time: time productID: productID insertDate: valid: true time: time toAccountID: toAccountID usagePeriodEndDate: valid: true time: time parentBillingEventID: parentBillingEventID disbursementBillingEventID: disbursementBillingEventID action: action offerID: offerID currency: currency invoiceID: invoiceID id: id balanceImpacting: 5 amount: 5.962133916683182 endUserAccountID: endUserAccountID dataFeedProductID: dataFeedProductID entitlementID: entitlementID buyerID: buyerID invoiceDate: valid: true time: time transactionReferenceID: transactionReferenceID organizationID: organizationID transactionType: transactionType paymentDueDate: valid: true time: time fromAccountID: fromAccountID agreementID: agreementID billingAddressID: billingAddressID bankTraceID: bankTraceID resellerName: resellerName resource: resource billingModel: SubscriptionBased channel: '{}' idSource: idSource earningId: earningId resellerId: resellerId disbursementNotificationSent: true azureRevenueRecords: - purchaseRecordID: purchaseRecordID productID: productID termEndDate: termEndDate azureCustomerID: azureCustomerID billingModel: billingModel payoutStatus: payoutStatus resellerCity: resellerCity resellerID: resellerID programName: programName resellerState: resellerState azureAssetID: azureAssetID offerID: offerID earningUsd: 2.3021358869347655 invoiceID: invoiceID azurePlanID: azurePlanID paymentStatus: paymentStatus revenueUsd: 7.061401241503109 azureBillingAccountID: azureBillingAccountID entitlementID: entitlementID resellerEmail: resellerEmail buyerID: buyerID invoiceDate: valid: true time: time transactionDate: valid: true time: time earningID: earningID invoiceDueDate: valid: true time: time resellerCompany: resellerCompany organizationID: organizationID resellerCountry: resellerCountry paymentID: paymentID termStartDate: termStartDate azureOfferID: azureOfferID estimatedPayoutMonth: valid: true time: time paymentSentDate: valid: true time: time - purchaseRecordID: purchaseRecordID productID: productID termEndDate: termEndDate azureCustomerID: azureCustomerID billingModel: billingModel payoutStatus: payoutStatus resellerCity: resellerCity resellerID: resellerID programName: programName resellerState: resellerState azureAssetID: azureAssetID offerID: offerID earningUsd: 2.3021358869347655 invoiceID: invoiceID azurePlanID: azurePlanID paymentStatus: paymentStatus revenueUsd: 7.061401241503109 azureBillingAccountID: azureBillingAccountID entitlementID: entitlementID resellerEmail: resellerEmail buyerID: buyerID invoiceDate: valid: true time: time transactionDate: valid: true time: time earningID: earningID invoiceDueDate: valid: true time: time resellerCompany: resellerCompany organizationID: organizationID resellerCountry: resellerCountry paymentID: paymentID termStartDate: termStartDate azureOfferID: azureOfferID estimatedPayoutMonth: valid: true time: time paymentSentDate: valid: true time: time paymentId: paymentId disbursementBillingEventId: disbursementBillingEventId bankTraceId: bankTraceId creditAmount: 9.301444243932576 gcpRevenueRecords: - productID: productID usage: 1.1730742509559433 withheld: 4.965218492984954 paymentType: paymentType accountID: accountID refundBalanceOutstanding: 1.4894159098541704 reportDate: reportDate trialUse: 7.457744773683766 paymentSchedule: paymentSchedule offerID: offerID currency: currency prepayCredits: 1.2315135367772556 abandoned: 3.616076749251911 sku: sku released: 6.84685269835264 usedBy: usedBy insightAccountID: insightAccountID dueVendor: 4.145608029883936 resource: resource googleEntity: googleEntity refundReason: refundReason entitlementID: entitlementID buyerID: buyerID organizationID: organizationID charges: 2.027123023002322 unit: unit refundBalanceDeductedThisMonth: 1.0246457001441578 ordinal: 7 - productID: productID usage: 1.1730742509559433 withheld: 4.965218492984954 paymentType: paymentType accountID: accountID refundBalanceOutstanding: 1.4894159098541704 reportDate: reportDate trialUse: 7.457744773683766 paymentSchedule: paymentSchedule offerID: offerID currency: currency prepayCredits: 1.2315135367772556 abandoned: 3.616076749251911 sku: sku released: 6.84685269835264 usedBy: usedBy insightAccountID: insightAccountID dueVendor: 4.145608029883936 resource: resource googleEntity: googleEntity refundReason: refundReason entitlementID: entitlementID buyerID: buyerID organizationID: organizationID charges: 2.027123023002322 unit: unit refundBalanceDeductedThisMonth: 1.0246457001441578 ordinal: 7 - date: 2000-01-23 04:56:07+00:00 amount: 0.8008281904610115 productID: productID refundDisburseAmount: 9.965781217890562 entitlementID: entitlementID invoiceAmount: 5.025004791520295 buyerID: buyerID invoiceDate: 2000-01-23 04:56:07+00:00 collectableAmount: 6.027456183070403 disburseDate: 2000-01-23 04:56:07+00:00 refundInvoiceDate: 2000-01-23 04:56:07+00:00 refundDisburseDate: 2000-01-23 04:56:07+00:00 organizationID: organizationID paymentDueDate: 2000-01-23 04:56:07+00:00 refundInvoiceAmount: 9.369310271410669 partner: partner currency: currency disburseAmount: 1.4658129805029452 id: id taxAmount: 6.683562403749608 info: awsRevenueRecords: - brokerID: brokerID usagePeriodStartDate: valid: true time: time productID: productID insertDate: valid: true time: time toAccountID: toAccountID usagePeriodEndDate: valid: true time: time parentBillingEventID: parentBillingEventID disbursementBillingEventID: disbursementBillingEventID action: action offerID: offerID currency: currency invoiceID: invoiceID id: id balanceImpacting: 5 amount: 5.962133916683182 endUserAccountID: endUserAccountID dataFeedProductID: dataFeedProductID entitlementID: entitlementID buyerID: buyerID invoiceDate: valid: true time: time transactionReferenceID: transactionReferenceID organizationID: organizationID transactionType: transactionType paymentDueDate: valid: true time: time fromAccountID: fromAccountID agreementID: agreementID billingAddressID: billingAddressID bankTraceID: bankTraceID - brokerID: brokerID usagePeriodStartDate: valid: true time: time productID: productID insertDate: valid: true time: time toAccountID: toAccountID usagePeriodEndDate: valid: true time: time parentBillingEventID: parentBillingEventID disbursementBillingEventID: disbursementBillingEventID action: action offerID: offerID currency: currency invoiceID: invoiceID id: id balanceImpacting: 5 amount: 5.962133916683182 endUserAccountID: endUserAccountID dataFeedProductID: dataFeedProductID entitlementID: entitlementID buyerID: buyerID invoiceDate: valid: true time: time transactionReferenceID: transactionReferenceID organizationID: organizationID transactionType: transactionType paymentDueDate: valid: true time: time fromAccountID: fromAccountID agreementID: agreementID billingAddressID: billingAddressID bankTraceID: bankTraceID resellerName: resellerName resource: resource billingModel: SubscriptionBased channel: '{}' idSource: idSource earningId: earningId resellerId: resellerId disbursementNotificationSent: true azureRevenueRecords: - purchaseRecordID: purchaseRecordID productID: productID termEndDate: termEndDate azureCustomerID: azureCustomerID billingModel: billingModel payoutStatus: payoutStatus resellerCity: resellerCity resellerID: resellerID programName: programName resellerState: resellerState azureAssetID: azureAssetID offerID: offerID earningUsd: 2.3021358869347655 invoiceID: invoiceID azurePlanID: azurePlanID paymentStatus: paymentStatus revenueUsd: 7.061401241503109 azureBillingAccountID: azureBillingAccountID entitlementID: entitlementID resellerEmail: resellerEmail buyerID: buyerID invoiceDate: valid: true time: time transactionDate: valid: true time: time earningID: earningID invoiceDueDate: valid: true time: time resellerCompany: resellerCompany organizationID: organizationID resellerCountry: resellerCountry paymentID: paymentID termStartDate: termStartDate azureOfferID: azureOfferID estimatedPayoutMonth: valid: true time: time paymentSentDate: valid: true time: time - purchaseRecordID: purchaseRecordID productID: productID termEndDate: termEndDate azureCustomerID: azureCustomerID billingModel: billingModel payoutStatus: payoutStatus resellerCity: resellerCity resellerID: resellerID programName: programName resellerState: resellerState azureAssetID: azureAssetID offerID: offerID earningUsd: 2.3021358869347655 invoiceID: invoiceID azurePlanID: azurePlanID paymentStatus: paymentStatus revenueUsd: 7.061401241503109 azureBillingAccountID: azureBillingAccountID entitlementID: entitlementID resellerEmail: resellerEmail buyerID: buyerID invoiceDate: valid: true time: time transactionDate: valid: true time: time earningID: earningID invoiceDueDate: valid: true time: time resellerCompany: resellerCompany organizationID: organizationID resellerCountry: resellerCountry paymentID: paymentID termStartDate: termStartDate azureOfferID: azureOfferID estimatedPayoutMonth: valid: true time: time paymentSentDate: valid: true time: time paymentId: paymentId disbursementBillingEventId: disbursementBillingEventId bankTraceId: bankTraceId creditAmount: 9.301444243932576 gcpRevenueRecords: - productID: productID usage: 1.1730742509559433 withheld: 4.965218492984954 paymentType: paymentType accountID: accountID refundBalanceOutstanding: 1.4894159098541704 reportDate: reportDate trialUse: 7.457744773683766 paymentSchedule: paymentSchedule offerID: offerID currency: currency prepayCredits: 1.2315135367772556 abandoned: 3.616076749251911 sku: sku released: 6.84685269835264 usedBy: usedBy insightAccountID: insightAccountID dueVendor: 4.145608029883936 resource: resource googleEntity: googleEntity refundReason: refundReason entitlementID: entitlementID buyerID: buyerID organizationID: organizationID charges: 2.027123023002322 unit: unit refundBalanceDeductedThisMonth: 1.0246457001441578 ordinal: 7 - productID: productID usage: 1.1730742509559433 withheld: 4.965218492984954 paymentType: paymentType accountID: accountID refundBalanceOutstanding: 1.4894159098541704 reportDate: reportDate trialUse: 7.457744773683766 paymentSchedule: paymentSchedule offerID: offerID currency: currency prepayCredits: 1.2315135367772556 abandoned: 3.616076749251911 sku: sku released: 6.84685269835264 usedBy: usedBy insightAccountID: insightAccountID dueVendor: 4.145608029883936 resource: resource googleEntity: googleEntity refundReason: refundReason entitlementID: entitlementID buyerID: buyerID organizationID: organizationID charges: 2.027123023002322 unit: unit refundBalanceDeductedThisMonth: 1.0246457001441578 ordinal: 7 nextOffset: 0 properties: nextOffset: type: integer revenueRecords: description: list of revenue records. items: $ref: '#/components/schemas/RevenueRecord' type: array type: object ListSupportTicketsResponse: example: totalCount: 6 items: - creator: creator attachments: - date: date thumbnail_small: thumbnail_small thumbnail_medium: thumbnail_medium size: 0 thumbnail_large: thumbnail_large mimetype: mimetype id: id title: title url: url - date: date thumbnail_small: thumbnail_small thumbnail_medium: thumbnail_medium size: 0 thumbnail_large: thumbnail_large mimetype: mimetype id: id title: title url: url comments: - date: date comment_text: comment_text creator: '{}' comment: - image: thumbnail_small: thumbnail_small extension: extension thumbnail_medium: thumbnail_medium thumbnail_large: thumbnail_large name: name id: id title: title type: type url: url attachment: date: date thumbnail_small: thumbnail_small thumbnail_medium: thumbnail_medium size: 0 thumbnail_large: thumbnail_large mimetype: mimetype id: id title: title url: url text: text type: type frame: id: id url: url - image: thumbnail_small: thumbnail_small extension: extension thumbnail_medium: thumbnail_medium thumbnail_large: thumbnail_large name: name id: id title: title type: type url: url attachment: date: date thumbnail_small: thumbnail_small thumbnail_medium: thumbnail_medium size: 0 thumbnail_large: thumbnail_large mimetype: mimetype id: id title: title url: url text: text type: type frame: id: id url: url id: id - date: date comment_text: comment_text creator: '{}' comment: - image: thumbnail_small: thumbnail_small extension: extension thumbnail_medium: thumbnail_medium thumbnail_large: thumbnail_large name: name id: id title: title type: type url: url attachment: date: date thumbnail_small: thumbnail_small thumbnail_medium: thumbnail_medium size: 0 thumbnail_large: thumbnail_large mimetype: mimetype id: id title: title url: url text: text type: type frame: id: id url: url - image: thumbnail_small: thumbnail_small extension: extension thumbnail_medium: thumbnail_medium thumbnail_large: thumbnail_large name: name id: id title: title type: type url: url attachment: date: date thumbnail_small: thumbnail_small thumbnail_medium: thumbnail_medium size: 0 thumbnail_large: thumbnail_large mimetype: mimetype id: id title: title url: url text: text type: type frame: id: id url: url id: id creationTime: creationTime description: description watchers: - watchers - watchers dueTime: dueTime priority: LOW organizationId: organizationId closeTime: closeTime name: name id: id status: OPEN - creator: creator attachments: - date: date thumbnail_small: thumbnail_small thumbnail_medium: thumbnail_medium size: 0 thumbnail_large: thumbnail_large mimetype: mimetype id: id title: title url: url - date: date thumbnail_small: thumbnail_small thumbnail_medium: thumbnail_medium size: 0 thumbnail_large: thumbnail_large mimetype: mimetype id: id title: title url: url comments: - date: date comment_text: comment_text creator: '{}' comment: - image: thumbnail_small: thumbnail_small extension: extension thumbnail_medium: thumbnail_medium thumbnail_large: thumbnail_large name: name id: id title: title type: type url: url attachment: date: date thumbnail_small: thumbnail_small thumbnail_medium: thumbnail_medium size: 0 thumbnail_large: thumbnail_large mimetype: mimetype id: id title: title url: url text: text type: type frame: id: id url: url - image: thumbnail_small: thumbnail_small extension: extension thumbnail_medium: thumbnail_medium thumbnail_large: thumbnail_large name: name id: id title: title type: type url: url attachment: date: date thumbnail_small: thumbnail_small thumbnail_medium: thumbnail_medium size: 0 thumbnail_large: thumbnail_large mimetype: mimetype id: id title: title url: url text: text type: type frame: id: id url: url id: id - date: date comment_text: comment_text creator: '{}' comment: - image: thumbnail_small: thumbnail_small extension: extension thumbnail_medium: thumbnail_medium thumbnail_large: thumbnail_large name: name id: id title: title type: type url: url attachment: date: date thumbnail_small: thumbnail_small thumbnail_medium: thumbnail_medium size: 0 thumbnail_large: thumbnail_large mimetype: mimetype id: id title: title url: url text: text type: type frame: id: id url: url - image: thumbnail_small: thumbnail_small extension: extension thumbnail_medium: thumbnail_medium thumbnail_large: thumbnail_large name: name id: id title: title type: type url: url attachment: date: date thumbnail_small: thumbnail_small thumbnail_medium: thumbnail_medium size: 0 thumbnail_large: thumbnail_large mimetype: mimetype id: id title: title url: url text: text type: type frame: id: id url: url id: id creationTime: creationTime description: description watchers: - watchers - watchers dueTime: dueTime priority: LOW organizationId: organizationId closeTime: closeTime name: name id: id status: OPEN properties: items: items: $ref: '#/components/schemas/SupportTicket' type: array totalCount: description: Only available when the request is made with offset=0. type: integer type: object ListUsageMeteringDailyRecordsResponse: example: usageMeteringDailyRecords: - date: 2000-01-23 04:56:07+00:00 amount: 6.027456183070403 quantity: 1.4658129805029452 partner: '{}' entitlementID: entitlementID groupBysExpression: groupBysExpression key: key - date: 2000-01-23 04:56:07+00:00 amount: 6.027456183070403 quantity: 1.4658129805029452 partner: '{}' entitlementID: entitlementID groupBysExpression: groupBysExpression key: key nextOffset: 0 properties: nextOffset: type: integer usageMeteringDailyRecords: items: $ref: '#/components/schemas/UsageMeteringDailyRecord' type: array type: object ListUsageRecordGroupsResponse: example: usageRecordGroups: - creationTime: 2000-01-23 04:56:07+00:00 records: key: 9.301444243932576 entitlementID: entitlementID buyerID: buyerID organizationID: organizationID metaInfo: lagoAmount: 6.027456183070403 stripePeriodStartTime: 2000-01-23 04:56:07+00:00 metronomeDailyCostAmount: 1.4658129805029452 SkipValidation: true billableRecords: - quantity: 0.8008281904610115 key: key properties: key: '' - quantity: 0.8008281904610115 key: key properties: key: '' stripeInvoiceID: stripeInvoiceID originRecords: key: 2.3021358869347655 source: '{}' stripeSubscriptionItemID: stripeSubscriptionItemID lagoSubscriptionID: lagoSubscriptionID stripePeriodEndTime: 2000-01-23 04:56:07+00:00 stripeUsageRecordSummaryID: stripeUsageRecordSummaryID metronomeMonthlyInvoiceAmount: 5.962133916683182 metronomeMonthlyInvoiceAmountAdjusted: 5.637376656633329 lagoUsageStartTime: 2000-01-23 04:56:07+00:00 metronomeInvoiceID: metronomeInvoiceID stripeUsageRecordSummaryTotalUsage: 7 timestamp: 2000-01-23 04:56:07+00:00 partner: AWS serialID: 3 usageRecordReportID: usageRecordReportID id: id lastUpdateTime: 2000-01-23 04:56:07+00:00 reportedTime: 2000-01-23 04:56:07+00:00 status: status - creationTime: 2000-01-23 04:56:07+00:00 records: key: 9.301444243932576 entitlementID: entitlementID buyerID: buyerID organizationID: organizationID metaInfo: lagoAmount: 6.027456183070403 stripePeriodStartTime: 2000-01-23 04:56:07+00:00 metronomeDailyCostAmount: 1.4658129805029452 SkipValidation: true billableRecords: - quantity: 0.8008281904610115 key: key properties: key: '' - quantity: 0.8008281904610115 key: key properties: key: '' stripeInvoiceID: stripeInvoiceID originRecords: key: 2.3021358869347655 source: '{}' stripeSubscriptionItemID: stripeSubscriptionItemID lagoSubscriptionID: lagoSubscriptionID stripePeriodEndTime: 2000-01-23 04:56:07+00:00 stripeUsageRecordSummaryID: stripeUsageRecordSummaryID metronomeMonthlyInvoiceAmount: 5.962133916683182 metronomeMonthlyInvoiceAmountAdjusted: 5.637376656633329 lagoUsageStartTime: 2000-01-23 04:56:07+00:00 metronomeInvoiceID: metronomeInvoiceID stripeUsageRecordSummaryTotalUsage: 7 timestamp: 2000-01-23 04:56:07+00:00 partner: AWS serialID: 3 usageRecordReportID: usageRecordReportID id: id lastUpdateTime: 2000-01-23 04:56:07+00:00 reportedTime: 2000-01-23 04:56:07+00:00 status: status nextOffset: 0 properties: nextOffset: type: integer usageRecordGroups: items: $ref: '#/components/schemas/MeteringUsageRecordGroup' type: array type: object ListUsageRecordReportsResponse: example: usageRecordReports: - organizationID: organizationID entitlementTermID: entitlementTermID creationTime: 2000-01-23 04:56:07+00:00 partner: partner productID: productID entitlementID: entitlementID id: id buyerID: buyerID info: creditRecords: key: 2.3021358869347655 usedCommitAmountIncrement: 1.4894159098541704 gcpMeteringRequest: '{}' alibabaMeteringResponse: '{}' usedCommitAmount: 1.0246457001441578 reportedRecords: key: 1.2315135367772556 usedCreditAmount: 6.84685269835264 alibabaMeteringRequest: '{}' dimensionUnitListPrice: key: 9.301444243932576 azureMeteringRequest: '{}' aggregatedBillableRecords: - amount: 6.027456183070403 quantity: 1.4658129805029452 name: name billableMetricInfo: groupBys: - groupBys - groupBys propertyUniqueOn: propertyUniqueOn filterGroups: - filters: - valueType: STRING name: name operation: IS value: '{}' - valueType: STRING name: name operation: IS value: '{}' - filters: - valueType: STRING name: name operation: IS value: '{}' - valueType: STRING name: name operation: IS value: '{}' groupBysExpression: groupBysExpression billableMetricAggregationType: COUNT key: key uniqueCountAggregationResult: '{}' - amount: 6.027456183070403 quantity: 1.4658129805029452 name: name billableMetricInfo: groupBys: - groupBys - groupBys propertyUniqueOn: propertyUniqueOn filterGroups: - filters: - valueType: STRING name: name operation: IS value: '{}' - valueType: STRING name: name operation: IS value: '{}' - filters: - valueType: STRING name: name operation: IS value: '{}' - valueType: STRING name: name operation: IS value: '{}' groupBysExpression: groupBysExpression billableMetricAggregationType: COUNT key: key uniqueCountAggregationResult: '{}' awsMeteringResponse: '{}' dimensionUnitPrice: key: 3.616076749251911 startTime: 2000-01-23 04:56:07+00:00 decimalParts: key: 7.061401241503109 newDecimalParts: key: 4.145608029883936 recordsToReportBeforeAdjustmentAtListPrice: key: 7.386281948385884 azureMeteringResponse: '{}' message: message dimensionCategories: key: dimensionCategories awsMeteringRequest: '{}' usedCreditAmountIncrement: 7.457744773683766 gcpMeteringResponse: '{}' partner: partner includedRecords: key: 2.027123023002322 endTime: 2000-01-23 04:56:07+00:00 creditAmount: 5.637376656633329 commitAmount: 5.962133916683182 usageRecordGroupIds: - usageRecordGroupIds - usageRecordGroupIds status: '' - organizationID: organizationID entitlementTermID: entitlementTermID creationTime: 2000-01-23 04:56:07+00:00 partner: partner productID: productID entitlementID: entitlementID id: id buyerID: buyerID info: creditRecords: key: 2.3021358869347655 usedCommitAmountIncrement: 1.4894159098541704 gcpMeteringRequest: '{}' alibabaMeteringResponse: '{}' usedCommitAmount: 1.0246457001441578 reportedRecords: key: 1.2315135367772556 usedCreditAmount: 6.84685269835264 alibabaMeteringRequest: '{}' dimensionUnitListPrice: key: 9.301444243932576 azureMeteringRequest: '{}' aggregatedBillableRecords: - amount: 6.027456183070403 quantity: 1.4658129805029452 name: name billableMetricInfo: groupBys: - groupBys - groupBys propertyUniqueOn: propertyUniqueOn filterGroups: - filters: - valueType: STRING name: name operation: IS value: '{}' - valueType: STRING name: name operation: IS value: '{}' - filters: - valueType: STRING name: name operation: IS value: '{}' - valueType: STRING name: name operation: IS value: '{}' groupBysExpression: groupBysExpression billableMetricAggregationType: COUNT key: key uniqueCountAggregationResult: '{}' - amount: 6.027456183070403 quantity: 1.4658129805029452 name: name billableMetricInfo: groupBys: - groupBys - groupBys propertyUniqueOn: propertyUniqueOn filterGroups: - filters: - valueType: STRING name: name operation: IS value: '{}' - valueType: STRING name: name operation: IS value: '{}' - filters: - valueType: STRING name: name operation: IS value: '{}' - valueType: STRING name: name operation: IS value: '{}' groupBysExpression: groupBysExpression billableMetricAggregationType: COUNT key: key uniqueCountAggregationResult: '{}' awsMeteringResponse: '{}' dimensionUnitPrice: key: 3.616076749251911 startTime: 2000-01-23 04:56:07+00:00 decimalParts: key: 7.061401241503109 newDecimalParts: key: 4.145608029883936 recordsToReportBeforeAdjustmentAtListPrice: key: 7.386281948385884 azureMeteringResponse: '{}' message: message dimensionCategories: key: dimensionCategories awsMeteringRequest: '{}' usedCreditAmountIncrement: 7.457744773683766 gcpMeteringResponse: '{}' partner: partner includedRecords: key: 2.027123023002322 endTime: 2000-01-23 04:56:07+00:00 creditAmount: 5.637376656633329 commitAmount: 5.962133916683182 usageRecordGroupIds: - usageRecordGroupIds - usageRecordGroupIds status: '' nextOffset: 0 properties: nextOffset: type: integer usageRecordReports: items: $ref: '#/components/schemas/MeteringUsageRecordReport' type: array type: object MeteringDimension: description: The dimension to meter usage in entitlement. example: priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 types: - types - types description: description planName: planName usageCount: '{}' rate: 6.84685269835264 includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly valueType: '{}' name: name planId: planId category: category key: key skuId: skuId properties: category: type: string description: type: string includedBaseQuantities: description: how many quantities of this dimension are included in the commit. items: $ref: '#/components/schemas/AzureIncludedBaseQuantity' type: array key: type: string name: description: Display name of the dimension. For GCP Marketplace, it is the metering metric ID without plan prefix. type: string planId: description: 'The plan ID of the metering dimension. Applicable to GCP Marketplace only. No ISO duration suffix.' type: string planName: description: 'The name of the plan for the metering dimension. Applicable to GCP Marketplace only. It may contains the ISO duration suffix, such as P1Y.' type: string priceTiers: description: The price tiers of the metering dimension. Applicable to GCP Marketplace only. items: $ref: '#/components/schemas/GcpPriceTier' type: array rate: description: The unit price of this usage metering dimension. type: number skuId: description: The SKU ID of the metering dimension. Applicable to GCP Marketplace only. type: string types: items: type: string type: array usageCount: allOf: - $ref: '#/components/schemas/UsageCount' description: The current Dimension Usage Count. Available when call GetEntitlement API. type: object valueType: allOf: - $ref: '#/components/schemas/ValueType' description: The value type of the metering dimension quantity. Applicable to GCP Marketplace only. type: object type: object MeteringUsageRecord: example: quantity: 0.8008281904610115 key: key properties: key: '' properties: key: description: Key is the unique identifier of a billable metric. type: string properties: additionalProperties: true description: 'Properties is the filters of a billable metric. It should be equal to the filters of the billable metric.' type: object quantity: description: The quantity (or numeric value) of a billable metric. type: number type: object MeteringUsageRecordGroup: example: creationTime: 2000-01-23 04:56:07+00:00 records: key: 9.301444243932576 entitlementID: entitlementID buyerID: buyerID organizationID: organizationID metaInfo: lagoAmount: 6.027456183070403 stripePeriodStartTime: 2000-01-23 04:56:07+00:00 metronomeDailyCostAmount: 1.4658129805029452 SkipValidation: true billableRecords: - quantity: 0.8008281904610115 key: key properties: key: '' - quantity: 0.8008281904610115 key: key properties: key: '' stripeInvoiceID: stripeInvoiceID originRecords: key: 2.3021358869347655 source: '{}' stripeSubscriptionItemID: stripeSubscriptionItemID lagoSubscriptionID: lagoSubscriptionID stripePeriodEndTime: 2000-01-23 04:56:07+00:00 stripeUsageRecordSummaryID: stripeUsageRecordSummaryID metronomeMonthlyInvoiceAmount: 5.962133916683182 metronomeMonthlyInvoiceAmountAdjusted: 5.637376656633329 lagoUsageStartTime: 2000-01-23 04:56:07+00:00 metronomeInvoiceID: metronomeInvoiceID stripeUsageRecordSummaryTotalUsage: 7 timestamp: 2000-01-23 04:56:07+00:00 partner: AWS serialID: 3 usageRecordReportID: usageRecordReportID id: id lastUpdateTime: 2000-01-23 04:56:07+00:00 reportedTime: 2000-01-23 04:56:07+00:00 status: status properties: buyerID: type: string creationTime: format: date-time type: string entitlementID: type: string id: type: string lastUpdateTime: format: date-time type: string metaInfo: $ref: '#/components/schemas/MeteringUsageRecordGroupMetaInfo' organizationID: type: string partner: enum: - AWS - AZURE - GCP type: string records: additionalProperties: type: number type: object reportedTime: description: nullable format: date-time type: string serialID: type: integer status: type: string usageRecordReportID: type: string type: object MeteringUsageRecordGroupByKey: example: groupBysExpression: groupBysExpression id: id properties: groupBysExpression: description: GroupBysExpression is string expression of array of group bys. type: string id: description: ID is billableMetric ID (Key) type: string type: object MeteringUsageRecordGroupMetaInfo: example: lagoAmount: 6.027456183070403 stripePeriodStartTime: 2000-01-23 04:56:07+00:00 metronomeDailyCostAmount: 1.4658129805029452 SkipValidation: true billableRecords: - quantity: 0.8008281904610115 key: key properties: key: '' - quantity: 0.8008281904610115 key: key properties: key: '' stripeInvoiceID: stripeInvoiceID originRecords: key: 2.3021358869347655 source: '{}' stripeSubscriptionItemID: stripeSubscriptionItemID lagoSubscriptionID: lagoSubscriptionID stripePeriodEndTime: 2000-01-23 04:56:07+00:00 stripeUsageRecordSummaryID: stripeUsageRecordSummaryID metronomeMonthlyInvoiceAmount: 5.962133916683182 metronomeMonthlyInvoiceAmountAdjusted: 5.637376656633329 lagoUsageStartTime: 2000-01-23 04:56:07+00:00 metronomeInvoiceID: metronomeInvoiceID stripeUsageRecordSummaryTotalUsage: 7 timestamp: 2000-01-23 04:56:07+00:00 properties: SkipValidation: description: If it is true, the validation of the usage record group is skipped. type: boolean billableRecords: description: for usage metering API v2 items: $ref: '#/components/schemas/MeteringUsageRecord' type: array lagoAmount: description: 'The lago amount (in dollars) of the customer. This field keeps the largest of the monthly amount. So it can only be updated when the invoice month increases.' type: number lagoSubscriptionID: description: The lago subscription ID of the customer. type: string lagoUsageStartTime: description: The lago usage start time of the customer usage. format: date-time type: string metronomeDailyCostAmount: description: The metronome daily cost amount (in dollars) of the customer. type: number metronomeInvoiceID: description: The metronome invoice ID of the customer. type: string metronomeMonthlyInvoiceAmount: description: 'The metronome monthly invoice amount (in dollars) of the customer. This field keeps the largest amount of the invoice month. So it can only be updated when the invoice month increases.' type: number metronomeMonthlyInvoiceAmountAdjusted: description: 'The metronome monthly invoice amount (in dollars) of the customer, which is adjusted by the seller. This field is populated only when the invoice amount is decreased by the seller via credit granting.' type: number originRecords: additionalProperties: type: number description: 'The original records reported by the customer before convertion. If no dimension mapping is applied, this field is the same as the records field.' type: object source: allOf: - $ref: '#/components/schemas/UsageRecordGroupSource' description: The source of the usage record group. Can be from Suger API or other third party services, such as Metronome. type: object stripeInvoiceID: type: string stripePeriodEndTime: description: The stripe period end time of the summary or invoice. UTC time in format "YYYY-MM-DDTHH:MM:SSZ". format: date-time type: string stripePeriodStartTime: description: The stripe period start time of the summary or invoice. UTC time in format "YYYY-MM-DDTHH:MM:SSZ". format: date-time type: string stripeSubscriptionItemID: type: string stripeUsageRecordSummaryID: type: string stripeUsageRecordSummaryTotalUsage: type: integer timestamp: description: 'The timestamp (UTC)) of when the usage records were generated. Optional, if not provided, the current report timestamp will be used.' format: date-time type: string type: object MeteringUsageRecordReport: example: organizationID: organizationID entitlementTermID: entitlementTermID creationTime: 2000-01-23 04:56:07+00:00 partner: partner productID: productID entitlementID: entitlementID id: id buyerID: buyerID info: creditRecords: key: 2.3021358869347655 usedCommitAmountIncrement: 1.4894159098541704 gcpMeteringRequest: '{}' alibabaMeteringResponse: '{}' usedCommitAmount: 1.0246457001441578 reportedRecords: key: 1.2315135367772556 usedCreditAmount: 6.84685269835264 alibabaMeteringRequest: '{}' dimensionUnitListPrice: key: 9.301444243932576 azureMeteringRequest: '{}' aggregatedBillableRecords: - amount: 6.027456183070403 quantity: 1.4658129805029452 name: name billableMetricInfo: groupBys: - groupBys - groupBys propertyUniqueOn: propertyUniqueOn filterGroups: - filters: - valueType: STRING name: name operation: IS value: '{}' - valueType: STRING name: name operation: IS value: '{}' - filters: - valueType: STRING name: name operation: IS value: '{}' - valueType: STRING name: name operation: IS value: '{}' groupBysExpression: groupBysExpression billableMetricAggregationType: COUNT key: key uniqueCountAggregationResult: '{}' - amount: 6.027456183070403 quantity: 1.4658129805029452 name: name billableMetricInfo: groupBys: - groupBys - groupBys propertyUniqueOn: propertyUniqueOn filterGroups: - filters: - valueType: STRING name: name operation: IS value: '{}' - valueType: STRING name: name operation: IS value: '{}' - filters: - valueType: STRING name: name operation: IS value: '{}' - valueType: STRING name: name operation: IS value: '{}' groupBysExpression: groupBysExpression billableMetricAggregationType: COUNT key: key uniqueCountAggregationResult: '{}' awsMeteringResponse: '{}' dimensionUnitPrice: key: 3.616076749251911 startTime: 2000-01-23 04:56:07+00:00 decimalParts: key: 7.061401241503109 newDecimalParts: key: 4.145608029883936 recordsToReportBeforeAdjustmentAtListPrice: key: 7.386281948385884 azureMeteringResponse: '{}' message: message dimensionCategories: key: dimensionCategories awsMeteringRequest: '{}' usedCreditAmountIncrement: 7.457744773683766 gcpMeteringResponse: '{}' partner: partner includedRecords: key: 2.027123023002322 endTime: 2000-01-23 04:56:07+00:00 creditAmount: 5.637376656633329 commitAmount: 5.962133916683182 usageRecordGroupIds: - usageRecordGroupIds - usageRecordGroupIds status: '' properties: buyerID: type: string creationTime: format: date-time type: string entitlementID: type: string entitlementTermID: type: string id: type: string info: $ref: '#/components/schemas/MeteringUsageRecordReportInfo' organizationID: type: string partner: type: string productID: type: string type: object MeteringUsageRecordReportInfo: example: creditRecords: key: 2.3021358869347655 usedCommitAmountIncrement: 1.4894159098541704 gcpMeteringRequest: '{}' alibabaMeteringResponse: '{}' usedCommitAmount: 1.0246457001441578 reportedRecords: key: 1.2315135367772556 usedCreditAmount: 6.84685269835264 alibabaMeteringRequest: '{}' dimensionUnitListPrice: key: 9.301444243932576 azureMeteringRequest: '{}' aggregatedBillableRecords: - amount: 6.027456183070403 quantity: 1.4658129805029452 name: name billableMetricInfo: groupBys: - groupBys - groupBys propertyUniqueOn: propertyUniqueOn filterGroups: - filters: - valueType: STRING name: name operation: IS value: '{}' - valueType: STRING name: name operation: IS value: '{}' - filters: - valueType: STRING name: name operation: IS value: '{}' - valueType: STRING name: name operation: IS value: '{}' groupBysExpression: groupBysExpression billableMetricAggregationType: COUNT key: key uniqueCountAggregationResult: '{}' - amount: 6.027456183070403 quantity: 1.4658129805029452 name: name billableMetricInfo: groupBys: - groupBys - groupBys propertyUniqueOn: propertyUniqueOn filterGroups: - filters: - valueType: STRING name: name operation: IS value: '{}' - valueType: STRING name: name operation: IS value: '{}' - filters: - valueType: STRING name: name operation: IS value: '{}' - valueType: STRING name: name operation: IS value: '{}' groupBysExpression: groupBysExpression billableMetricAggregationType: COUNT key: key uniqueCountAggregationResult: '{}' awsMeteringResponse: '{}' dimensionUnitPrice: key: 3.616076749251911 startTime: 2000-01-23 04:56:07+00:00 decimalParts: key: 7.061401241503109 newDecimalParts: key: 4.145608029883936 recordsToReportBeforeAdjustmentAtListPrice: key: 7.386281948385884 azureMeteringResponse: '{}' message: message dimensionCategories: key: dimensionCategories awsMeteringRequest: '{}' usedCreditAmountIncrement: 7.457744773683766 gcpMeteringResponse: '{}' partner: partner includedRecords: key: 2.027123023002322 endTime: 2000-01-23 04:56:07+00:00 creditAmount: 5.637376656633329 commitAmount: 5.962133916683182 usageRecordGroupIds: - usageRecordGroupIds - usageRecordGroupIds status: '' properties: aggregatedBillableRecords: description: The aggregated billable records from the usage metering API v2. items: $ref: '#/components/schemas/AggregatedMeteringUsageRecord' type: array alibabaMeteringRequest: allOf: - $ref: '#/components/schemas/client.PushMeteringDataRequest' description: The raw request to call Alibaba metering service. type: object alibabaMeteringResponse: allOf: - $ref: '#/components/schemas/client.PushMeteringDataResponseBody' description: The raw response from Alibaba metering service. type: object awsMeteringRequest: allOf: - $ref: '#/components/schemas/AwsMarketplaceMeteringBatchMeterUsageInput' description: The raw request to call AWS metering service. type: object awsMeteringResponse: allOf: - $ref: '#/components/schemas/marketplacemetering.BatchMeterUsageOutput' description: The raw response from AWS metering service. type: object azureMeteringRequest: allOf: - $ref: '#/components/schemas/AzureMarketplaceMeteringBatchUsageEvent' description: The raw request to call Azure metering service. type: object azureMeteringResponse: allOf: - $ref: '#/components/schemas/github_com_sugerio_marketplace-service_third_party_azure_sdk_marketplacemeteringv1.BatchUsageEventOkResponse' description: The raw response from Azure metering service. type: object commitAmount: description: The amount of the commit if applicable. type: number creditAmount: description: The amount of the credit if applicable. type: number creditRecords: additionalProperties: type: number description: The credit usage records in the map of for usage metering API v1. type: object decimalParts: additionalProperties: type: number description: 'The decimal parts of the usage dimension quantity in the map of , before this usage record report.' type: object dimensionCategories: additionalProperties: type: string description: 'The categories of the usage records in the map of . The dimension category is required when reporting usage records to Alibaba Marketplace. It comes from the metering dimension category.' type: object dimensionUnitListPrice: additionalProperties: type: number description: The public list price of each dimension in the map of . type: object dimensionUnitPrice: additionalProperties: type: number description: 'The unit price of each dimension in the map of . It can be the negotiated price in the private offer or the public list price.' type: object endTime: description: time in UTC when the UsageRecordReport ends format: date-time type: string gcpMeteringRequest: allOf: - $ref: '#/components/schemas/GcpMarketplaceMeteringOperation' description: The raw request to call GCP metering service. type: object gcpMeteringResponse: allOf: - $ref: '#/components/schemas/servicecontrol.ReportResponse' description: The raw response from GCP metering service. type: object includedRecords: additionalProperties: type: number description: The included usage records in the map of for usage metering API v1. type: object message: type: string newDecimalParts: additionalProperties: type: number description: 'The decimal parts of the usage dimension quantity in the map of , after this usage record report.' type: object partner: description: The partner where this usage record report is sent to. Such as AWS, AZURE or GCP. type: string recordsToReportBeforeAdjustmentAtListPrice: additionalProperties: type: number description: 'The usage records to report before the adjustment by the commit with additional usage at list price, in the map of .' type: object reportedRecords: additionalProperties: type: number description: The reported usage records in the map of for usage metering API v1. type: object startTime: description: time in UTC when the UsageRecordReport starts format: date-time type: string status: $ref: '#/components/schemas/UsageRecordReportStatus' usageRecordGroupIds: description: The IDs of UsageRecordGroups aggregated in this UsageRecordReport. items: type: string type: array usedCommitAmount: description: The amount of the used commit before this usage record report if applicable. type: number usedCommitAmountIncrement: description: The amount of the used commit increment in this usage record report if applicable. type: number usedCreditAmount: description: The amount of the used credit before this usage record report if applicable. type: number usedCreditAmountIncrement: description: The amount of the used credit increment in this usage record report if applicable. type: number type: object NewUsageRecordGroup: example: metaInfo: '{}' records: key: 0.8008281904610115 billableRecords: - quantity: 0.8008281904610115 key: key properties: key: '' - quantity: 0.8008281904610115 key: key properties: key: '' entitlementID: entitlementID timestamp: 2000-01-23 04:56:07+00:00 properties: billableRecords: description: for usage metering API v2, don't use it together with the records v1. items: $ref: '#/components/schemas/MeteringUsageRecord' type: array entitlementID: type: string metaInfo: allOf: - $ref: '#/components/schemas/MeteringUsageRecordGroupMetaInfo' description: read-only, don't set it when validating or reporting the usage record group. type: object records: additionalProperties: type: number description: for usage metering API v1, don't use it together with the billableRecords v2. type: object timestamp: description: 'The timestamp of when the usage records were generated. Optional, if not provided, the current report timestamp will be used. This is not the timestamp of when the usage records were reported to Suger.' format: date-time type: string required: - entitlementID - records type: object NotificationChannel: enum: - EMAIL - SLACK - SMS - SNS - SALESFORCE - WEBHOOK - SUGER_SUPPORT - MICROSOFT_TEAMS type: string x-enum-comments: NotificationChannel_MICROSOFT_TEAMS: Notify Microsoft Teams. NotificationChannel_SNS: Amazon Simple Notification Service NotificationChannel_SUGER_SUPPORT: Notify Suger Support team. x-enum-varnames: - NotificationChannel_EMAIL - NotificationChannel_SLACK - NotificationChannel_SMS - NotificationChannel_SNS - NotificationChannel_SALESFORCE - NotificationChannel_WEBHOOK - NotificationChannel_SUGER_SUPPORT - NotificationChannel_MICROSOFT_TEAMS NotificationEvent: example: eventID: eventID customFields: key: '' entityType: '' contactEmails: - contactEmails - contactEmails entityID: entityID message: message priority: '{}' title: title contactIds: - contactIds - contactIds organizationID: organizationID ccContactIds: - ccContactIds - ccContactIds channels: - EMAIL - EMAIL isActionItem: true partner: '{}' createdBy: '{}' entityStatus: entityStatus entityName: entityName eventStatus: '{}' action: '' requireAudit: true trackEvents: - contactId: contactId action: OPEN_EMAIL timestamp: 2000-01-23 04:56:07+00:00 - contactId: contactId action: OPEN_EMAIL timestamp: 2000-01-23 04:56:07+00:00 info: '{}' lastUpdateTime: 2000-01-23 04:56:07+00:00 timestamp: 2000-01-23 04:56:07+00:00 properties: action: $ref: '#/components/schemas/NotificationEventAction' ccContactIds: description: Cc contactIds that will receive this notification items: type: string type: array channels: description: The list of channels this event will be sent to, e.g., ["SLACK", "EMAIL"] items: $ref: '#/components/schemas/NotificationChannel' type: array contactEmails: description: Contact emails that will receive this notification items: type: string type: array contactIds: description: ContactIds that will receive this notification items: type: string type: array createdBy: allOf: - $ref: '#/components/schemas/LastModifiedBy' description: 'Who originally created or triggered this notification event. It can be user or API client.' type: object customFields: additionalProperties: true description: Custom fields of the notification event. type: object entityID: type: string entityName: description: The name of the entity. type: string entityStatus: type: string entityType: $ref: '#/components/schemas/EntityType' eventID: description: notification event id. type: string eventStatus: allOf: - $ref: '#/components/schemas/NotificationEventStatus' description: notification event status. type: object info: description: Additional info of the notification event. type: object isActionItem: description: If this notification event is an action item. type: boolean lastUpdateTime: description: timestamp of the event when it is updated. format: date-time type: string message: description: The message of the notification event such as email body, action item description. type: string organizationID: description: suger organization id. type: string partner: allOf: - $ref: '#/components/schemas/Partner' description: the partner of the entity. Optional. type: object priority: allOf: - $ref: '#/components/schemas/AuditingEventPriority' description: The priority of the notification event. type: object requireAudit: description: If this notification event is an auditing event and need to store in DB. type: boolean timestamp: description: timestamp of the event when it is scheduled or created. format: date-time type: string title: description: The title of the notification event such as email subject, action item title. type: string trackEvents: description: The track events of the notification event. items: $ref: '#/components/schemas/TrackEvent' type: array type: object NotificationEventAction: enum: - '' - ABNORMAL_ALERT - ACCEPT - ADD - APPROVE - CANCEL - CLOSE - CREATE - DELETE - ARCHIVE - DISBURSE - END_SOON - EXPIRE - EXPIRE_SOON - MERGE - METER - NEW_CLIENT_SIGNUP - NOTIFY - NOTIFY_CONTACTS - OPEN_EMAIL - PENDING_CANCEL - PENDING_ACCEPTANCE - REINSTATE - REJECT - REOPEN - CHARGE - REFUND - ISSUE - SIGN - ROTATE_SECRET - SUSPEND - TEST - UPDATE - ACE_ENGAGEMENT_SCORE_UPDATE - ACE_SALES_REP_UPDATE - ACE_CUSTOMER_EMAIL_UPDATE - AZURE_STATUS_UPDATE - SUBMIT_APPROVAL_REQUEST - REVIEW_APPROVAL_REQUEST - COMPLETE - FAIL - WEBHOOK - MARKETPLACE_CONTACT_EMAIL_UPDATE type: string x-enum-comments: NotificationEventAction_ADD: Add user to organization x-enum-varnames: - NotificationEventAction_UNKNOWN - NotificationEventAction_ABNORMAL_ALERT - NotificationEventAction_ACCEPT - NotificationEventAction_ADD - NotificationEventAction_APPROVE - NotificationEventAction_CANCEL - NotificationEventAction_CLOSE - NotificationEventAction_CREATE - NotificationEventAction_DELETE - NotificationEventAction_ARCHIVE - NotificationEventAction_DISBURSE - NotificationEventAction_END_SOON - NotificationEventAction_EXPIRE - NotificationEventAction_EXPIRE_SOON - NotificationEventAction_MERGE - NotificationEventAction_METER - NotificationEventAction_NEW_CLIENT_SIGNUP - NotificationEventAction_NOTIFY - NotificationEventAction_NOTIFY_CONTACTS - NotificationEventAction_OPEN_EMAIL - NotificationEventAction_PENDING_CANCEL - NotificationEventAction_PENDING_ACCEPTANCE - NotificationEventAction_REINSTATE - NotificationEventAction_REJECT - NotificationEventAction_REOPEN - NotificationEventAction_CHARGE - NotificationEventAction_REFUND - NotificationEventAction_ISSUE - NotificationEventAction_SIGN - NotificationEventAction_ROTATE_SECRET - NotificationEventAction_SUSPEND - NotificationEventAction_TEST - NotificationEventAction_UPDATE - NotificationEventAction_ACE_ENGAGEMENT_SCORE_UPDATE - NotificationEventAction_ACE_SALES_REP_UPDATE - NotificationEventAction_ACE_CUSTOMER_EMAIL_UPDATE - NotificationEventAction_AZURE_STATUS_UPDATE - NotificationEventAction_SUBMIT_APPROVAL_REQUEST - NotificationEventAction_REVIEW_APPROVAL_REQUEST - NotificationEventAction_COMPLETE - NotificationEventAction_FAIL - NotificationEventAction_WEBHOOK - NotificationEventAction_MARKETPLACE_CONTACT_EMAIL_UPDATE NotificationEventStatus: enum: - '' - SCHEDULED - PENDING - DONE - FAILED type: string x-enum-varnames: - NotificationEventStatus_UNKNOWN - NotificationEventStatus_SCHEDULED - NotificationEventStatus_PENDING - NotificationEventStatus_DONE - NotificationEventStatus_FAILED NotificationMessage: example: organizationID: organizationID creationTime: 2000-01-23 04:56:07+00:00 recipient: recipient id: id type: EMAIL info: standardFields: key: '' customFields: key: '' subject: subject rccRecipients: - rccRecipients - rccRecipients ccRecipients: - ccRecipients - ccRecipients action: '{}' textContent: textContent htmlContent: htmlContent properties: creationTime: format: date-time type: string id: type: string info: $ref: '#/components/schemas/NotificationMessageInfo' organizationID: type: string recipient: type: string type: $ref: '#/components/schemas/NotificationChannel' type: object NotificationMessageInfo: example: standardFields: key: '' customFields: key: '' subject: subject rccRecipients: - rccRecipients - rccRecipients ccRecipients: - ccRecipients - ccRecipients action: '{}' textContent: textContent htmlContent: htmlContent properties: action: allOf: - $ref: '#/components/schemas/NotificationEventAction' description: The action of this notification message. type: object ccRecipients: items: type: string type: array customFields: additionalProperties: true description: All other fields type: object htmlContent: description: The HTML content of the email. type: string rccRecipients: items: type: string type: array standardFields: additionalProperties: true description: The standard fields to render the email content. type: object subject: type: string textContent: description: The text content of the email in case the recipient's email client does not support HTML. type: string type: object OfferInfo: example: awsResaleAuthorizationId: awsResaleAuthorizationId additionalResellerEulaUrls: - additionalResellerEulaUrls - additionalResellerEulaUrls gcpSowAgreementDocument: '{}' resellerEulaUrl: resellerEulaUrl trialConfig: '{}' taxIds: - taxIds - taxIds paymentInstallments: - discountPercentage: 3.5571952270680973 amount: 9.018348186070783 originalAmount: 6.965117697638846 chargeOn: 2000-01-23 04:56:07+00:00 chargeOnStr: chargeOnStr credit: 6.438423552598547 - discountPercentage: 3.5571952270680973 amount: 9.018348186070783 originalAmount: 6.965117697638846 chargeOn: 2000-01-23 04:56:07+00:00 chargeOnStr: chargeOnStr credit: 6.438423552598547 billableDimensions: - priceModelTiered: '{}' priceModelTieredPercentage: '{}' priceModelMatrix: '{}' minimumCommit: 5.962133916683182 length: 1 priceModelBulk: '{}' description: description discount: '{}' minimumCommitScope: '{}' minimumCommitProrata: true billableMetricId: billableMetricId priceModelPercentage: '{}' name: name priceModelBasic: '{}' category: '{}' priceModelVolume: '{}' timeUnit: '{}' - priceModelTiered: '{}' priceModelTieredPercentage: '{}' priceModelMatrix: '{}' minimumCommit: 5.962133916683182 length: 1 priceModelBulk: '{}' description: description discount: '{}' minimumCommitScope: '{}' minimumCommitProrata: true billableMetricId: billableMetricId priceModelPercentage: '{}' name: name priceModelBasic: '{}' category: '{}' priceModelVolume: '{}' timeUnit: '{}' eulaUrl: eulaUrl attachEulaType: '{}' buyerAzureTenants: - description: description id: id - description: description id: id awsAgreementDuration: awsAgreementDuration refundCancellationPolicy: refundCancellationPolicy paymentSchedule: '{}' eulaMergeOrder: - 1 - 1 azureOriginalPlan: '{}' gcpPrivateOffer: '{}' netTermsInDays: 8 azureProductVariant: '{}' gcpResellerPrivateOfferPlan: offerTemplatePolicies: allowScheduledStartDate: true allowAutoRenewal: true maxRenewalTimes: maxRenewalTimes offerDealType: OFFER_DEAL_TYPE_UNSPECIFIED proration: PRORATION_UNSPECIFIED displayName: displayName agreementDocuments: isvToCustomerAgreementDocument: documentBody: documentBody documentType: documentType unstructuredDocument: content: content name: name description: description updateTime: 2000-01-23 04:56:07+00:00 externalGoogleLink: '{}' isvToResellerAgreementDocument: documentBody: documentBody documentType: documentType unstructuredDocument: content: content name: name description: description updateTime: 2000-01-23 04:56:07+00:00 externalGoogleLink: '{}' features: - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription isvInfo: contactEmail: contactEmail contactName: contactName partnerAdvantageAccountLegalName: partnerAdvantageAccountLegalName partnerAdvantageId: partnerAdvantageId paymentSchedule: '' installmentTimelineTemplate: installmentTemplates: - priceModelTemplate: baseOffer: baseOffer commitment: commitmentAmountPerPeriodTemplate: decimalAmountConstraint: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units currencyCode: currencyCode period: unit: MONTHLY_PERIOD count: 9 discountTemplate: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode consumption: overage payg: period: unit: MONTHLY_PERIOD count: 9 discountTemplate: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode skuDiscountTemplates: - '{}' - '{}' skuRepresentation: skuList: skus: - skus - skus skus: skus skuGroupList: '{}' subscription: fixedPrice fixedPrice: period: unit: MONTHLY_PERIOD count: 9 discountTemplate: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode overage: discountTemplate: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode skuDiscountTemplates: - '{}' - '{}' skuRepresentation: skuList: skus: - skus - skus skus: skus skuGroupList: '{}' startTime: 2000-01-23 04:56:07+00:00 - priceModelTemplate: baseOffer: baseOffer commitment: commitmentAmountPerPeriodTemplate: decimalAmountConstraint: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units currencyCode: currencyCode period: unit: MONTHLY_PERIOD count: 9 discountTemplate: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode consumption: overage payg: period: unit: MONTHLY_PERIOD count: 9 discountTemplate: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode skuDiscountTemplates: - '{}' - '{}' skuRepresentation: skuList: skus: - skus - skus skus: skus skuGroupList: '{}' subscription: fixedPrice fixedPrice: period: unit: MONTHLY_PERIOD count: 9 discountTemplate: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode overage: discountTemplate: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode skuDiscountTemplates: - '{}' - '{}' skuRepresentation: skuList: skus: - skus - skus skus: skus skuGroupList: '{}' startTime: 2000-01-23 04:56:07+00:00 state: cancellationReason: '{}' stateType: '' comment: comment rejectionReason: '{}' stateTransitions: - transitionTime: 2000-01-23 04:56:07+00:00 newState: stateType: null - transitionTime: 2000-01-23 04:56:07+00:00 newState: stateType: null reusePolicy: '' margin: marginPercentage: value: value agreement: agreement durationConfig: startTime: 2000-01-23 04:56:07+00:00 endTime: 2000-01-23 04:56:07+00:00 priceModelTemplate: '{}' startPolicy: '' updateTime: 2000-01-23 04:56:07+00:00 productInfo: flavorExternalName: flavorExternalName providerId: providerId serviceLevel: serviceLevel serviceName: serviceName productExternalName: productExternalName metaInfo: gcpOrganizationId: gcpOrganizationId gcpProjectNumber: gcpProjectNumber resellerInfo: billingAccountOrgDisplayName: billingAccountOrgDisplayName resellerPrivateOfferPlanScope: resellerPrivateOfferPlanScope partnerAccountName: partnerAccountName notesToReseller: notesToReseller resellerContactName: resellerContactName resellOfferTemplateId: resellOfferTemplateId billingAccountId: billingAccountId billingAccountType: billingAccountType billingAccountNickname: billingAccountNickname resellerContactEmail: resellerContactEmail resellerPrivateOfferPlanId: resellerPrivateOfferPlanId subBillingAccount: subBillingAccount name: name resellOfferTemplate: resellOfferTemplate replacementMetadata: '{}' acceptanceDeadlineTime: 2000-01-23 04:56:07+00:00 amendmentContext: '{}' offerTermTemplate: paymentRecurrence: paymentRecurrence termDurationConstraint: defaultDuration: unit: MONTHLY_PERIOD count: 9 startPolicy: '' startTime: 2000-01-23 04:56:07+00:00 endTime: 2000-01-23 04:56:07+00:00 enableScheduledStartTimes: true termDuration: unit: MONTHLY_PERIOD count: 9 visibility: PRIVATE eulaType: '' awsMarkupPercentage: 6.027456183070403 gracePeriodInDays: 6 gcpOfferDealType: '{}' gcpCustomerInfo: '{}' gcpProviderPublicNote: gcpProviderPublicNote gcpDuration: 4 billingCycle: '{}' gcpMetrics: - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 displayUnitDescription: displayUnitDescription unit: unit metricKind: metricKind displayName: displayName valueType: '{}' name: name description: description displayUnit: displayUnit id: id reportingUnit: reportingUnit skuId: skuId - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 displayUnitDescription: displayUnitDescription unit: unit metricKind: metricKind displayName: displayName valueType: '{}' name: name description: description displayUnit: displayUnit id: id reportingUnit: reportingUnit skuId: skuId commits: - types: - types - types quantity: 4 length: 9 description: description type: '{}' maximumUsers: 361608 rate: 7.386281948385884 isUserCreated: true minimumUsers: 202713 name: name term: term category: category termEndTime: termEndTime key: key timeUnit: '{}' - types: - types - types quantity: 4 length: 9 description: description type: '{}' maximumUsers: 361608 rate: 7.386281948385884 isUserCreated: true minimumUsers: 202713 name: name term: term category: category termEndTime: termEndTime key: key timeUnit: '{}' isMeteringOverageCommit: true proratedBilling: true awsChannelPartner: '{}' awsCppoOpportunity: '{}' usageBillingIntervalInMonths: 1 privateOfferUrl: privateOfferUrl discountPercentage: 7.457744773683766 pdfURL: pdfURL awsMachineLearningContractDuration: 0 commitBillingIntervalInMonths: 7 docusignEnvelopeIds: key: docusignEnvelopeIds billingIntervalInMonths: 5 gcpProviderInfo: '{}' autoRenew: true currency: currency startTime: 2000-01-23 04:56:07+00:00 azurePrivateOffer: '{}' gcpPaymentSchedule: '{}' gcpProviderInternalNote: gcpProviderInternalNote gcpPlans: - priceInfo: usageFees: - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 subscriptionPlans: - period: period price: nanos: 1 units: units currencyCode: currencyCode - period: period price: nanos: 1 units: units currencyCode: currencyCode description: description priceModel: FREE purchaseMode: PURCHASE_MODE_PRIVATE name: name title: title featureValues: - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription - priceInfo: usageFees: - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 subscriptionPlans: - period: period price: nanos: 1 units: units currencyCode: currencyCode - period: period price: nanos: 1 units: units currencyCode: currencyCode description: description priceModel: FREE purchaseMode: PURCHASE_MODE_PRIVATE name: name title: title featureValues: - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription resellerAttachEulaType: '{}' awsCppoEventDetail: '{}' sellerNotes: sellerNotes buyerAwsAccountIds: - buyerAwsAccountIds - buyerAwsAccountIds gcpUsagePlanPriceModel: '{}' additionalEulaUrls: - additionalEulaUrls - additionalEulaUrls resellerEulaType: '{}' commitAmount: 2.3021358869347655 dimensions: - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 types: - types - types description: description planName: planName usageCount: '{}' rate: 6.84685269835264 includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly valueType: '{}' name: name planId: planId category: category key: key skuId: skuId - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 types: - types - types description: description planName: planName usageCount: '{}' rate: 6.84685269835264 includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly valueType: '{}' name: name planId: planId category: category key: key skuId: skuId snowflakeOffer: '{}' properties: additionalEulaUrls: description: 'The URL of the additional EULA files. Only applicable when EulaType = CUSTOM. The additional EULA files will be attached to the EULA file in the EulaUrl, and form a single EULA file.' items: type: string type: array additionalResellerEulaUrls: description: The URL of the additional reseller EULA files. Only applicable when ResellerEulaType = CUSTOM. items: type: string type: array attachEulaType: allOf: - $ref: '#/components/schemas/EulaType' description: Attach the standard EULA file to the CUSTOM EULA file. Only applicable when EulaType = CUSTOM type: object autoRenew: description: Is this offer Auto Renew enabled. type: boolean awsAgreementDuration: description: 'Aws private subscription offer Usage duration. ISO8601 format. P300D means the contract Usage start date At acceptance, and with duration 300 days.' type: string awsChannelPartner: allOf: - $ref: '#/components/schemas/AwsChannelPartner' description: The AWS channel partner (reseller), only applicable for AWS Marketplace CPPO_OUT or CPPO offers. type: object awsCppoEventDetail: allOf: - $ref: '#/components/schemas/AwsMarketplaceEventBridgeEventDetail' description: AWS EventBridge Event, only applicable for AWS Marketplace CPPO offers. type: object awsCppoOpportunity: allOf: - $ref: '#/components/schemas/AwsMarketplaceCppoOpportunity' description: AWS CPPO Opportunity, only applicable for AWS Marketplace CPPO_OUT or CPPO_IN offers. type: object awsMachineLearningContractDuration: description: 'For AWS machine learning contract private offer only. The contract duration of the offer in months.' type: integer awsMarkupPercentage: description: AWS private reseller offer using markup percentage. 10.0 represent 10% partner margin. type: number awsResaleAuthorizationId: description: AWS ResaleAuthorizationId(CPPO_IN offer id) for CPPO offers of the reseller. type: string azureOriginalPlan: allOf: - $ref: '#/components/schemas/AzureMarketplacePriceAndAvailabilityPrivateOfferPlan' description: The origin pricing of Azure plan. Only applicable for Azure Marketplace plans. type: object azurePrivateOffer: allOf: - $ref: '#/components/schemas/AzureMarketplacePrivateOffer' description: The private offer for Azure Marketplace. Only applicable for Azure Marketplace private offers. type: object azureProductVariant: allOf: - $ref: '#/components/schemas/AzureProductVariant' description: For Azure marketplace only. type: object billableDimensions: description: Usage based metering dimensions based on Billable Metrics, managed by Suger only. items: $ref: '#/components/schemas/BillableDimension' type: array billingCycle: allOf: - $ref: '#/components/schemas/BillingCycle' description: Billing Cycle for the offer. type: object billingIntervalInMonths: description: Billing interval in months for the offer. type: integer buyerAwsAccountIds: description: The buyers' AWS Account IDs of this offer. items: type: string type: array buyerAzureTenants: description: The buyers' Azure tenants of this offer. items: $ref: '#/components/schemas/AzureAudience' type: array commitAmount: description: 'The amount that the buyer has committed to pay, before discount if applicable. It can be monthly commitment or total commitment. For frontend display or analysis purposes, not used for billing.' type: number commitBillingIntervalInMonths: description: 'Deprecated: Use BillingIntervalInMonths instead.' type: integer commits: description: Recurring flat fee for the offer, managed by cloud marketplaces or Suger. items: $ref: '#/components/schemas/CommitDimension' type: array currency: description: The currency code of the offer. ISO 4217 format. type: string dimensions: description: Usage based metering dimensions defined on cloud marketplaces, managed by Cloud marketplaces only. items: $ref: '#/components/schemas/MeteringDimension' type: array discountPercentage: description: 'The discount percentage off the original price. For example, 20 means 20% off. 0 means no discount. It can be discount off the commitment amount or discount off the usage price.' type: number docusignEnvelopeIds: additionalProperties: type: string description: 'The Docusign envelope IDs generated for the offer. The key is the contact ID, the value is the Docusign envelope ID.' type: object eulaMergeOrder: description: 'The merge order of the EULA files. Only applicable when EulaType = CUSTOM. Elements are the original index of the EULA files in the index they should be transferred to, where original indexes are: AttachEulaType is index 0, EulaUrl is index 1, additionalEulaUrls is index 2 onwards.' items: type: integer type: array eulaType: $ref: '#/components/schemas/EulaType' eulaUrl: type: string gcpCustomerInfo: allOf: - $ref: '#/components/schemas/GcpMarketplacePrivateOfferCustomerInfo' description: Only required when creating GCP Marketplace private offer. type: object gcpDuration: description: The duration of the offer in months. Only required when creating GCP Marketplace private offer. type: integer gcpMetrics: description: Only applicable for GCP Marketplace Offers (the default or private offer) items: $ref: '#/components/schemas/GcpMarketplaceProductMeteringMetric' type: array gcpOfferDealType: allOf: - $ref: '#/components/schemas/GcpMarketplaceOfferDealType' description: Optional when creating GCP Marketplace private offer and replacement offer. type: object gcpPaymentSchedule: allOf: - $ref: '#/components/schemas/PaymentScheduleType' description: 'Only required when creating GCP Marketplace private offer, to specify the payment schedule for the private offer. TODO: It will be deprecated in the future and replaced by PaymentSchedule.' type: object gcpPlans: description: Only applicable for GCP Marketplace items: $ref: '#/components/schemas/GcpMarketplaceProductPurchaseOptionSpec' type: array gcpPrivateOffer: allOf: - $ref: '#/components/schemas/GcpMarketplacePrivateOffer' description: The private offer for GCP Marketplace. Only applicable for GCP Marketplace private offers. type: object gcpProviderInfo: allOf: - $ref: '#/components/schemas/GcpMarketplacePrivateOfferProviderInfo' description: Only required when creating GCP Marketplace private offer. type: object gcpProviderInternalNote: description: 'Optional when creating GCP Marketplace private offer. The internal note for the seller/ISV. It is only visible to the seller/ISV.' type: string gcpProviderPublicNote: description: 'Optional when creating GCP Marketplace private offer. By default, it is the same as offer name. The public note for the buyer. It is visible to the buyer.' type: string gcpResellerPrivateOfferPlan: $ref: '#/components/schemas/GcpMarketplaceResellerPrivateOfferPlan' gcpSowAgreementDocument: allOf: - $ref: '#/components/schemas/GcpAgreementDocument' description: Optional when creating GCP Marketplace private offer for professional services. type: object gcpUsagePlanPriceModel: allOf: - $ref: '#/components/schemas/GcpMarketplaceUsagePlanPriceModel' description: Only applicable for GCP Marketplace with Usage plan. Not appliable for Subscription plan. type: object gracePeriodInDays: description: 'The grace period in days for the offer. This is the number of days during which invoices remain in draft status, for reviewing. This filed can be overridden at the entitlement level.' type: integer isMeteringOverageCommit: description: 'Whether the usage metering will only be charged for the amount that exceeds the committed amount. e.g. the buyer has committed $100, and the usage is $120, - if true, the buyer will be charged for the usage at $20, and the commit at $100. - if false, the buyer will be charged for the usage at $120, and the commit at $100.' type: boolean netTermsInDays: description: 'The net terms in days for the offer. This is the number of days the buyer has to pay the invoice. This filed can be overridden at the entitlement level.' type: integer paymentInstallments: description: For flexible payment schedule, managed by cloud marketplaces or Suger. items: $ref: '#/components/schemas/PaymentInstallment' type: array paymentSchedule: allOf: - $ref: '#/components/schemas/PaymentScheduleType' description: 'The payment schedule for the offer. PREPAY means the buyer pays before the service is provided. POSTPAY means the buyer pays after the service is provided.' type: object pdfURL: description: 'Not needed when creating stripe offer This URL points to the PDF version of the offer.' type: string privateOfferUrl: description: The URL of the private offer sent to buyers to accept. Only applicable for private offer. type: string proratedBilling: description: 'Prorated billing for the offer. If true, the billing is prorated based on the start date and end date. If false, the billing is not prorated. This filed can be overridden at the entitlement level.' type: boolean refundCancellationPolicy: type: string resellerAttachEulaType: allOf: - $ref: '#/components/schemas/EulaType' description: Attach the standard EULA file to the CUSTOM EULA file. Only applicable when EulaType = CUSTOM type: object resellerEulaType: allOf: - $ref: '#/components/schemas/EulaType' description: The type of the reseller EULA. Only applicable for CPPO offers. type: object resellerEulaUrl: type: string sellerNotes: type: string snowflakeOffer: allOf: - $ref: '#/components/schemas/SnowflakeMarketplaceOffer' description: The private offer for Snowflake marketplace. Only applicable for Snowflake Marketplace offers. type: object startTime: description: 'Optional when creating AWS or GCP Marketplace private offer on the contract product. The future start time of the offer if it is not started on the acceptance.' format: date-time type: string taxIds: description: 'Tax ids for the offer, used to calculate the tax amount for the offer. This field can be overridden at the entitlement level.' items: type: string type: array trialConfig: allOf: - $ref: '#/components/schemas/TrialConfig' description: 'The offer for Direct. Only applicable for Direct offers. It is used in Stripe, Adyen, and other direct payment providers. The trial configuration for the offer.' type: object usageBillingIntervalInMonths: description: 'Deprecated: Use BillingIntervalInMonths instead.' type: integer visibility: description: The default visibility of offer is PRIVATE. enum: - PRIVATE - PUBLIC type: string type: object OfferStatus: enum: - '' - INVALID - ACCEPTED - ACTIVE - CANCEL_FAILED - CANCEL_SUCCESS - CANCELLED - CREATE_FAILED - CREATE_SUCCESS - DELETED - DEPRECATED - DRAFT - EXPIRED - PENDING_ACCEPTANCE - PENDING_CANCEL - PENDING_CREATE - PENDING_UPDATE - PREVIEW - READY_TO_USE - REJECTED - RESTRICTED - TEST - UPDATE_FAILED - UPDATE_SUCCESS - USED type: string x-enum-comments: OfferStatus_USED: For AWS CPPO_OUT offer used by the channel partner. x-enum-varnames: - OfferStatus_UNKNOWN - OfferStatus_INVALID - OfferStatus_ACCEPTED - OfferStatus_ACTIVE - OfferStatus_CANCEL_FAILED - OfferStatus_CANCEL_SUCCESS - OfferStatus_CANCELLED - OfferStatus_CREATE_FAILED - OfferStatus_CREATE_SUCCESS - OfferStatus_DELETED - OfferStatus_DEPRECATED - OfferStatus_DRAFT - OfferStatus_EXPIRED - OfferStatus_PENDING_ACCEPTANCE - OfferStatus_PENDING_CANCEL - OfferStatus_PENDING_CREATE - OfferStatus_PENDING_UPDATE - OfferStatus_PREVIEW - OfferStatus_READY_TO_USE - OfferStatus_REJECTED - OfferStatus_RESTRICTED - OfferStatus_TEST - OfferStatus_UPDATE_FAILED - OfferStatus_UPDATE_SUCCESS - OfferStatus_USED OfferType: enum: - UNKNOWN - AMI - APPLICATION - CONTAINER - CONTRACT - CPPO_OUT - CPPO_IN - CPPO - CUD - DATA - DEFAULT - FIXED_FEE - FIXED_FEE_WITH_OVERAGE - FLAT_RATE - FREE_TRIAL - PAYG - PAYG_WITH_CUD - PER_USER - PRIVATE - PROFESSIONAL_SERVICES - SUBSCRIPTION - MACHINE_LEARNING type: string x-enum-varnames: - OfferType_UNKNOWN - OfferType_AMI - OfferType_APPLICATION - OfferType_CONTAINER - OfferType_CONTRACT - OfferType_CPPO_OUT - OfferType_CPPO_IN - OfferType_CPPO - OfferType_CUD - OfferType_DATA - OfferType_DEFAULT - OfferType_FIXED_FEE - OfferType_FIXED_FEE_WITH_OVERAGE - OfferType_FLAT_RATE - OfferType_FREE_TRIAL - OfferType_PAYG - OfferType_PAYG_WITH_CUD - OfferType_PER_USER - OfferType_PRIVATE - OfferType_PROFESSIONAL_SERVICES - OfferType_SUBSCRIPTION - OfferType_MACHINE_LEARNING Partner: enum: - '' - ADYEN - ALIBABA - AWS - AWS_CHINA - AZURE - CHARGEBEE - DATABRICKS - DOCUSIGN - GCP - GOOGLE - HUBSPOT - INTUIT - LAGO - MARKETO - METRONOME - MICROSOFT - ORACLE - ORB - REDHAT - SALESFORCE - SLACK - SNOWFLAKE - STRIPE - ZOHO type: string x-enum-varnames: - Partner_UNKNOWN - Partner_ADYEN - Partner_ALIBABA - Partner_AWS - Partner_AWS_CHINA - Partner_AZURE - Partner_CHARGEBEE - Partner_DATABRICKS - Partner_DOCUSIGN - Partner_GCP - Partner_GOOGLE - Partner_HUBSPOT - Partner_INTUIT - Partner_LAGO - Partner_MARKETO - Partner_METRONOME - Partner_MICROSOFT - Partner_ORACLE - Partner_ORB - Partner_REDHAT - Partner_SALESFORCE - Partner_SLACK - Partner_SNOWFLAKE - Partner_STRIPE - Partner_ZOHO PartnerService: enum: - DEFAULT - ACE - BIGQUERY - BILLING - CHATBOT - COSELL - CRM - CPQ - DATABASE - DRIVE - EMAIL - MARKETPLACE - NETSUITE - PAYMENT - QUICKBOOKS - STORAGE - TEAMS type: string x-enum-comments: PartnerService_ACE: for AWS ACE Cosell PartnerService_BIGQUERY: for GCP Bigquery. PartnerService_BILLING: for Billing/metering service. PartnerService_COSELL: for Azure or GCP Co-sell PartnerService_DRIVE: for Google Drive. PartnerService_NETSUITE: for Oracle Netsuite. PartnerService_PAYMENT: for Stripe/Adyen PartnerService_QUICKBOOKS: for Intuit Quickbooks. PartnerService_STORAGE: for Google Cloud Storage. PartnerService_TEAMS: for Microsoft Teams x-enum-varnames: - PartnerService_DEFAULT - PartnerService_ACE - PartnerService_BIGQUERY - PartnerService_BILLING - PartnerService_CHATBOT - PartnerService_COSELL - PartnerService_CRM - PartnerService_CPQ - PartnerService_DATABASE - PartnerService_DRIVE - PartnerService_EMAIL - PartnerService_MARKETPLACE - PartnerService_NETSUITE - PartnerService_PAYMENT - PartnerService_QUICKBOOKS - PartnerService_STORAGE - PartnerService_TEAMS PartnerUsageMeteringConfig: example: enableCommitWithAdditionalUsageAtListPrice: true enableDimensionMapping: true dimensionMapping: key: convertionMultiplier: 0.8008281904610115 dimensionKey: dimensionKey mappingMode: '{}' partner: '{}' enableBillableDimension: true enableCommitWithAdditionalUsageMetering: true dimensionMappingV2: key: - convertionMultiplier: 0.8008281904610115 dimensionKey: dimensionKey mappingMode: '{}' - convertionMultiplier: 0.8008281904610115 dimensionKey: dimensionKey mappingMode: '{}' properties: dimensionMapping: additionalProperties: $ref: '#/components/schemas/UsageMeteringDimensionMappingValue' description: 'Deprecated: Use DimensionMappingV2 instead. The mapping of the source dimension key to the destination dimension key of the usage metering.' type: object dimensionMappingV2: additionalProperties: items: $ref: '#/components/schemas/UsageMeteringDimensionMappingValue' type: array description: 'The mapping of the source dimension key to the destination dimension keys of the usage metering. The destination dimension keys are the list of the destination dimension keys. So the source dimension key can be mapped to multiple destination dimension keys.' type: object enableBillableDimension: type: boolean enableCommitWithAdditionalUsageAtListPrice: description: 'Enable the commit (discount) with additional usage metering at list price. Only applicable if EnableCommitWithAdditionalUsageMetering is true. The default is false, which means the commit with additional usage metering at the discounted price in the private offer. If set to true, the additional usage is metered at the list price (the price in public product listing) instead of the discounted price.' type: boolean enableCommitWithAdditionalUsageMetering: description: 'Enable the commit with additional usage metering. The default is false, which means all usage records are reported to partner no matter how much is the commit. If set to true, the usage records will be reported to partner only if the current commit has been exhausted.' type: boolean enableDimensionMapping: description: 'Enable the dimension mapping for the usage metering. The default is false, which means no dimension conversion and just use the origin dimension.' type: boolean partner: allOf: - $ref: '#/components/schemas/Partner' description: The partner in this dimension mapping. Required. Such as AWS, AZURE or GCP. type: object type: object PaymentConfig: properties: allowedWalletTypes: description: Allowed wallet types for this buyer, include payment methods from payment provider such as card, us_bank_account and credit. items: $ref: '#/components/schemas/BillingWalletType' type: array currency: description: Currency used for billing. type: string defaultWalletId: description: Default wallet id which is a stripe payment method used to invoice. type: string type: object PaymentInstallment: example: discountPercentage: 3.5571952270680973 amount: 9.018348186070783 originalAmount: 6.965117697638846 chargeOn: 2000-01-23 04:56:07+00:00 chargeOnStr: chargeOnStr credit: 6.438423552598547 properties: amount: description: 'The amount the buyer has paid for this installment. If there is a discount off the original price, the amount is the discounted price.' type: number chargeOn: description: 'When the buyer will be charged for this installment. If it is null, the buyer will be charged on the effective date of the entitlement.' format: date-time type: string chargeOnStr: description: The charge on date in string format. It is used for front-end display only. type: string credit: description: 'Used in GCP Marketplace private offer as one-time credit. Default as zero if there is no credit.' type: number discountPercentage: description: 'The discount percentage off the original price. For GCP Marketplace, it can be discount off the commitment amount or discount off the usage price. The value is between 0 to 100. For example, 20 means 20% off. Default as zero if there is no discount.' type: number originalAmount: description: 'The original amount before discount if there is a discount off the original price. nil if there is no discount.' type: number type: object PaymentScheduleType: enum: - '' - PREPAY - POSTPAY type: string x-enum-varnames: - PaymentScheduleType_UNKNOWN - PaymentScheduleType_PREPAY - PaymentScheduleType_POSTPAY PriceModelBasic: properties: unitAmount: type: number type: object PriceModelBulk: properties: bulkAmount: description: A currency amount to rate usage by type: number bulkSize: description: 'An integer amount to represent package size. For example, 1000 here would divide usage by 1000 before multiplying by package_amount in rating' type: integer type: object PriceModelCategory: enum: - basic - tiered - bulk - volume - percentage - tiered-percentage - matrix type: string x-enum-varnames: - PriceModelCategory_Basic - PriceModelCategory_Tiered - PriceModelCategory_Bulk - PriceModelCategory_Volume - PriceModelCategory_Percentage - PriceModelCategory_TieredPercentage - PriceModelCategory_Matrix PriceModelMatrix: properties: defaultUnitAmount: type: number matrix: description: The matrix of the pricing model items: $ref: '#/components/schemas/PriceModelMatrixConfigGroup' type: array type: object PriceModelMatrixConfigGroup: properties: properties: items: $ref: '#/components/schemas/PriceModelMatrixProperty' type: array unitAmount: type: number type: object PriceModelMatrixProperty: properties: name: type: string value: type: string type: object PriceModelPercentage: properties: flatFee: type: number percentageRate: description: Basis point take rate per event type: number type: object PriceModelTiered: properties: tiers: items: $ref: '#/components/schemas/PriceModelTieredConfig' type: array type: object PriceModelTieredConfig: properties: firstUnit: description: Inclusive tier starting value type: number flatFee: type: number lastUnit: description: Exclusive tier ending value. If null, this is treated as the last tier type: number unitAmount: description: Amount per unit type: number type: object PriceModelTieredPercentage: properties: tiers: items: $ref: '#/components/schemas/PriceModelTieredPercentageConfig' type: array type: object PriceModelTieredPercentageConfig: properties: firstUnit: description: Inclusive tier starting value type: number flatFee: type: number lastUnit: description: Exclusive tier ending value. If null, this is treated as the last tier type: number percentageRate: type: number type: object PriceModelVolume: properties: tiers: items: $ref: '#/components/schemas/PriceModelVolumeConfig' type: array type: object PriceModelVolumeConfig: properties: flatFee: type: number maximumUnits: description: Upper bound for this tier type: number unitAmount: description: Amount per unit type: number type: object PrivateOfferDiscountType: enum: - absolute - percentage type: string x-enum-varnames: - PrivateOfferDiscountType_absolute - PrivateOfferDiscountType_percentage ProductInfo: example: eulaType: '{}' awsSaasProduct: Repositories: - Type: Type Url: Url - Type: Type Url: Url Description: UsW9Submitted: true Highlights: - Highlights - Highlights Categories: - Categories - Categories ProductCode: ProductCode SearchKeywords: - SearchKeywords - SearchKeywords ProductTitle: ProductTitle EuW8Submitted: true ShortDescription: ShortDescription LongDescription: LongDescription Manufacturer: Manufacturer Visibility: Limited AssociatedProducts: '{}' Sku: Sku Registered: true Versions: - CreationDate: 2000-01-23 04:56:07+00:00 Id: Id DeliveryOptions: - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription ReleaseNotes: ReleaseNotes VersionTitle: VersionTitle - CreationDate: 2000-01-23 04:56:07+00:00 Id: Id DeliveryOptions: - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription ReleaseNotes: ReleaseNotes VersionTitle: VersionTitle productId: productId PromotionalResources: AdditionalResources: - Type: Type Text: Text Url: Url - Type: Type Text: Text Url: Url LogoUrl: LogoUrl Videos: - Type: Type Title: Title Url: Url - Type: Type Title: Title Url: Url dataFeedProductId: dataFeedProductId Dimensions: - Types: - Types - Types Description: Description Length: 2 Rate: 6.778324963048013 TimeUnit: DAY Unit: Unit Key: Key Name: Name - Types: - Types - Types Description: Description Length: 2 Rate: 6.778324963048013 TimeUnit: DAY Unit: Unit Key: Key Name: Name SignatureVerificationKeys: - Status: Status PublicKey: PublicKey PublicKeyVersion: 2 - Status: Status PublicKey: PublicKey PublicKeyVersion: 2 SupportInformation: Description: Description awsContainerProduct: Repositories: - Type: Type Url: Url - Type: Type Url: Url Description: UsW9Submitted: true Highlights: - Highlights - Highlights Categories: - Categories - Categories ProductCode: ProductCode SearchKeywords: - SearchKeywords - SearchKeywords ProductTitle: ProductTitle EuW8Submitted: true ShortDescription: ShortDescription LongDescription: LongDescription Manufacturer: Manufacturer Visibility: Limited AssociatedProducts: '{}' Sku: Sku Registered: true Versions: - CreationDate: 2000-01-23 04:56:07+00:00 Id: Id DeliveryOptions: - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription ReleaseNotes: ReleaseNotes VersionTitle: VersionTitle - CreationDate: 2000-01-23 04:56:07+00:00 Id: Id DeliveryOptions: - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription ReleaseNotes: ReleaseNotes VersionTitle: VersionTitle productId: productId PromotionalResources: AdditionalResources: - Type: Type Text: Text Url: Url - Type: Type Text: Text Url: Url LogoUrl: LogoUrl Videos: - Type: Type Title: Title Url: Url - Type: Type Title: Title Url: Url dataFeedProductId: dataFeedProductId Dimensions: - Types: - Types - Types Description: Description Length: 2 Rate: 6.778324963048013 TimeUnit: DAY Unit: Unit Key: Key Name: Name - Types: - Types - Types Description: Description Length: 2 Rate: 6.778324963048013 TimeUnit: DAY Unit: Unit Key: Key Name: Name SignatureVerificationKeys: - Status: Status PublicKey: PublicKey PublicKeyVersion: 2 - Status: Status PublicKey: PublicKey PublicKeyVersion: 2 SupportInformation: Description: Description alibabaProduct: FrontCategoryId: 6 Status: Status Description: Description RequestId: RequestId ShopInfo: WangWangs: WangWang: - UserName: UserName Remark: Remark - UserName: UserName Remark: Remark Telephones: Telephone: - Telephone - Telephone Emails: Emails Id: 7 Name: Name ProductSkus: ProductSku: - Constraints: Constraints ChargeType: ChargeType Modules: Module: - Id: Id Properties: Property: - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name Code: Code Name: Name - Id: Id Properties: Property: - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name Code: Code Name: Name OrderPeriods: OrderPeriod: - PeriodType: PeriodType Name: Name - PeriodType: PeriodType Name: Name Hidden: true Code: Code Name: Name - Constraints: Constraints ChargeType: ChargeType Modules: Module: - Id: Id Properties: Property: - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name Code: Code Name: Name - Id: Id Properties: Property: - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name Code: Code Name: Name OrderPeriods: OrderPeriod: - PeriodType: PeriodType Name: Name - PeriodType: PeriodType Name: Name Hidden: true Code: Code Name: Name UseCount: 3 GmtModified: 5 GmtCreated: 1 Code: Code Name: Name ShortDescription: ShortDescription SupplierPk: 9 Score: 2.3021358869347655 Type: Type AuditStatus: AuditStatus AuditFailMsg: AuditFailMsg ProductExtras: ProductExtra: - Order: 5 Type: Type Label: Label Values: '{}' Key: Key - Order: 5 Type: Type Label: Label Values: '{}' Key: Key AuditTime: 0 PicUrl: PicUrl awsSnsSubscriptions: - Status: UNKNOWN Endpoint: Endpoint TopicArn: TopicArn Protocol: Protocol SubscriptionArn: SubscriptionArn - Status: UNKNOWN Endpoint: Endpoint TopicArn: TopicArn Protocol: Protocol SubscriptionArn: SubscriptionArn azureProductResource: customerLeads: salesforceLeadConfiguration: '{}' product: product $schema: $schema tableLeadConfiguration: '{}' httpsEndpointLeadConfiguration: '{}' resourceName: resourceName emailLeadConfiguration: '{}' dynamicsLeadConfiguration: '{}' marketoLeadConfiguration: '{}' leadDestination: none id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message blobLeadConfiguration: '{}' product: lifecycleState: null $schema: $schema productGroup: productGroup identity: externalId: externalId alias: alias resourceName: resourceName id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message type: azureApplication priceAndAvailabilityOffer: product: product $schema: $schema previewAudiences: - id: id label: label type: none - id: id label: label type: none resourceName: resourceName id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message technicalConfiguration: azureAdTenantId: azureAdTenantId product: product $schema: $schema azureAdAppId: azureAdAppId resourceName: resourceName id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message connectionWebhook: connectionWebhook landingPageUrl: landingPageUrl listingAssets: - lifecycleState: '{}' fileName: fileName product: product $schema: $schema kind: azure displayOrder: 6 languageId: languageId description: description resourceName: resourceName type: azureLogoSmall url: url id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message listing: listing friendlyName: friendlyName - lifecycleState: '{}' fileName: fileName product: product $schema: $schema kind: azure displayOrder: 6 languageId: languageId description: description resourceName: resourceName type: azureLogoSmall url: url id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message listing: listing friendlyName: friendlyName plans: - planListing: summary: summary lifecycleState: null product: product $schema: $schema kind: azureVM-plan languageId: languageId name: name description: description resourceName: resourceName id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message plan: plan priceAndAvailabilityPlan: audience: public product: product softwareReservation: - percentageSave: 6.704019297950036 term: 3.353193347011243 type: month - percentageSave: 6.704019297950036 term: 3.353193347011243 type: month $schema: $schema visibility: visible meterDefine: meterDefine billingTag: billingTag resourceName: resourceName trial: type: day value: 7.386281948385884 markets: - markets - markets privateAudiences: - id: id label: label type: none - id: id label: label type: none id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message plan: plan pricing: customMeters: priceInputOption: perMarket meters: key: pricePerPaymentInUsd: 6.778324963048013 includedQuantities: - quantity: 2.8841621266687802 isInfinite: true billingTerm: type: day value: 7.386281948385884 - quantity: 2.8841621266687802 isInfinite: true billingTerm: type: day value: 7.386281948385884 billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - pricePerPaymentInUsd: 6.878052220127876 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency - pricePerPaymentInUsd: 6.878052220127876 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency licenseModel: byol systemMeterPricing: price: 5.944895607614016 priceInputOption: perCore prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency corePricing: price: 6.965117697638846 priceInputOption: free pricePerCoreSize: '{}' pricePerCore: 1.284659006116532 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency recurrentPrice: recurrentPriceMode: flatRate userLimits: min: 6.84685269835264 max: 1.4894159098541704 priceInputOption: perMarket prices: - billingFrequency: '{}' pricePerPaymentInUsd: 1.2315135367772556 flexibleSchedule: '{}' contractDuration: '{}' billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency - billingFrequency: '{}' pricePerPaymentInUsd: 1.2315135367772556 flexibleSchedule: '{}' contractDuration: '{}' billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency plan: deprecationSchedule: date: date reason: criticalSecurityIssue $schema: $schema alternative: product: '{}' plan: '{}' dateOffset: dateOffset lifecycleState: null product: product displayRank: 3 $schema: $schema azureGovernmentCertifications: - link: link name: name - link: link name: name resourceName: resourceName azureRegions: - azureRegions - azureRegions subtype: managedApplication identity: externalId: externalId alias: alias id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - planListing: summary: summary lifecycleState: null product: product $schema: $schema kind: azureVM-plan languageId: languageId name: name description: description resourceName: resourceName id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message plan: plan priceAndAvailabilityPlan: audience: public product: product softwareReservation: - percentageSave: 6.704019297950036 term: 3.353193347011243 type: month - percentageSave: 6.704019297950036 term: 3.353193347011243 type: month $schema: $schema visibility: visible meterDefine: meterDefine billingTag: billingTag resourceName: resourceName trial: type: day value: 7.386281948385884 markets: - markets - markets privateAudiences: - id: id label: label type: none - id: id label: label type: none id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message plan: plan pricing: customMeters: priceInputOption: perMarket meters: key: pricePerPaymentInUsd: 6.778324963048013 includedQuantities: - quantity: 2.8841621266687802 isInfinite: true billingTerm: type: day value: 7.386281948385884 - quantity: 2.8841621266687802 isInfinite: true billingTerm: type: day value: 7.386281948385884 billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - pricePerPaymentInUsd: 6.878052220127876 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency - pricePerPaymentInUsd: 6.878052220127876 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency licenseModel: byol systemMeterPricing: price: 5.944895607614016 priceInputOption: perCore prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency corePricing: price: 6.965117697638846 priceInputOption: free pricePerCoreSize: '{}' pricePerCore: 1.284659006116532 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency recurrentPrice: recurrentPriceMode: flatRate userLimits: min: 6.84685269835264 max: 1.4894159098541704 priceInputOption: perMarket prices: - billingFrequency: '{}' pricePerPaymentInUsd: 1.2315135367772556 flexibleSchedule: '{}' contractDuration: '{}' billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency - billingFrequency: '{}' pricePerPaymentInUsd: 1.2315135367772556 flexibleSchedule: '{}' contractDuration: '{}' billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency plan: deprecationSchedule: date: date reason: criticalSecurityIssue $schema: $schema alternative: product: '{}' plan: '{}' dateOffset: dateOffset lifecycleState: null product: product displayRank: 3 $schema: $schema azureGovernmentCertifications: - link: link name: name - link: link name: name resourceName: resourceName azureRegions: - azureRegions - azureRegions subtype: managedApplication identity: externalId: externalId alias: alias id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message property: lifecycleState: null appVersion: appVersion product: product $schema: $schema termsConditions: custom kind: azureSaaS resourceName: resourceName customAmendments: - tenants: manualEntries: - description: description id: id - description: description id: id terms: terms - tenants: manualEntries: - description: description id: id - description: description id: id terms: terms cloudIndustries: key: - cloudIndustries - cloudIndustries standardContractAmendment: standardContractAmendment termsOfUseUrl: termsOfUseUrl termsOfUse: termsOfUse industries: key: - industries - industries categories: key: - categories - categories id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message reseller: product: product $schema: $schema resellerChannelState: resellerChannelState audiences: - resourceId: resourceId description: description type: subscription - resourceId: resourceId description: description type: subscription resourceName: resourceName id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message setup: product: product $schema: $schema accessUrl: accessUrl useMicrosoftLicenseManagementService: true sellThroughMicrosoft: true resourceName: resourceName id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message requireLicenseForInstall: true callToAction: free submission: result: succeeded deprecationSchedule: date: date reason: criticalSecurityIssue $schema: $schema alternative: product: '{}' plan: '{}' dateOffset: dateOffset lifecycleState: null product: product $schema: $schema created: created resourceName: resourceName id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message status: notStarted target: targetId: targetId targetType: flight listing: generalLinks: - displayText: displayText link: link - displayText: displayText link: link lifecycleState: '{}' cloudSolutionProviderMarketingMaterials: cloudSolutionProviderMarketingMaterials product: product supportContact: phone: phone name: name email: email url: url governmentSupportWebsite: governmentSupportWebsite $schema: $schema searchKeywords: - searchKeywords - searchKeywords kind: azureSaaS languageId: languageId description: description resourceName: resourceName shortDescription: shortDescription title: title privacyPolicyLink: privacyPolicyLink gettingStartedInstructions: gettingStartedInstructions gloabalSupportWebsite: gloabalSupportWebsite cloudSolutionProviderContact: phone: phone name: name email: email url: url engineeringContact: phone: phone name: name email: email url: url id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message searchResultSummary: searchResultSummary priceAndAvailabilityCustomMeter: product: product $schema: $schema customMeters: key: unitOfMeasure: unitOfMeasure displayName: displayName price: 3.0937452626664474 resourceName: resourceName id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message awsAmiProduct: Repositories: - Type: Type Url: Url - Type: Type Url: Url Description: UsW9Submitted: true Highlights: - Highlights - Highlights Categories: - Categories - Categories ProductCode: ProductCode SearchKeywords: - SearchKeywords - SearchKeywords ProductTitle: ProductTitle EuW8Submitted: true ShortDescription: ShortDescription LongDescription: LongDescription Manufacturer: Manufacturer Visibility: Limited AssociatedProducts: '{}' Sku: Sku Registered: true Versions: - CreationDate: 2000-01-23 04:56:07+00:00 Id: Id DeliveryOptions: - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription ReleaseNotes: ReleaseNotes VersionTitle: VersionTitle - CreationDate: 2000-01-23 04:56:07+00:00 Id: Id DeliveryOptions: - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription ReleaseNotes: ReleaseNotes VersionTitle: VersionTitle productId: productId PromotionalResources: AdditionalResources: - Type: Type Text: Text Url: Url - Type: Type Text: Text Url: Url LogoUrl: LogoUrl Videos: - Type: Type Title: Title Url: Url - Type: Type Title: Title Url: Url dataFeedProductId: dataFeedProductId Dimensions: - Types: - Types - Types Description: Description Length: 2 Rate: 6.778324963048013 TimeUnit: DAY Unit: Unit Key: Key Name: Name - Types: - Types - Types Description: Description Length: 2 Rate: 6.778324963048013 TimeUnit: DAY Unit: Unit Key: Key Name: Name SignatureVerificationKeys: - Status: Status PublicKey: PublicKey PublicKeyVersion: 2 - Status: Status PublicKey: PublicKey PublicKeyVersion: 2 SupportInformation: Description: Description eulaUrl: eulaUrl sellerNotes: sellerNotes snowflakeProduct: profileName: profileName evaluationPlan: evaluationPlan metadata: hasFreeSampleData: true areTermsProvidedOffline: true usage: '{}' description: description businessNeeds: '{}' share: share paidAttributes: '{}' title: title isWithStandardTerms: true private: true additionalRegions: additionalRegions globalName: globalName regions: regions autofulfillment: true flags: flags pricingPlans: - updated_on: updated_on billing_duration_months: '0' metadata: key: metadata visibility: visibility display_name: display_name usage_details: free_unit_kind: free_unit_kind free_units: 5.533258397034986 usage_unit_kind: usage_unit_kind max_fee: 3.2588565619047607 usage_unit_price: 4.078845849666752 base_fee: 7.04836565559697 contract_type: contract_type sales_motion: sales_motion pricing_model: pricing_model name: name comment: comment currency: currency state: state contract_duration_months: '0' - updated_on: updated_on billing_duration_months: '0' metadata: key: metadata visibility: visibility display_name: display_name usage_details: free_unit_kind: free_unit_kind free_units: 5.533258397034986 usage_unit_kind: usage_unit_kind max_fee: 3.2588565619047607 usage_unit_price: 4.078845849666752 base_fee: 7.04836565559697 contract_type: contract_type sales_motion: sales_motion pricing_model: pricing_model name: name comment: comment currency: currency state: state contract_duration_months: '0' listingType: listingType distribution: distribution createdOn: createdOn customizedContactInfo: customizedContactInfo fulfillmentType: fulfillmentType shareType: shareType unpublishedByAdminReason: unpublishedByAdminReason scheduledDropTime: scheduledDropTime firstPublishedOn: firstPublishedOn isMountlessQueryable: true state: state attachedShare: attachedShare detailedTargetAccounts: - company_name: company_name account_identifier: account_identifier - company_name: company_name account_identifier: account_identifier publishOnApproval: true defaultPricingPlan: free_unit_kind: free_unit_kind trial_usage_unit: trial_usage_unit usage_unit_kind: usage_unit_kind is_auto_renewable: true installment_schedule: default_installment_amount: 6.519180951018382 overridden_installments: - installment_amount: 4.652396432933246 installment_number: 8.969578798196912 - installment_amount: 4.652396432933246 installment_number: 8.969578798196912 installment_duration: 0.10263654006109402 type: type base_fee: 7.143538047012306 payment_type: payment_type free_units: 7.058770351582356 allow_early_access: true currency: currency billing_duration: 0 trial_usage_limit: 3.0205796992916243 max_fee: 7.740351818741173 usage_unit_price: 3.0576100241049344 updatedOn: updatedOn retiredOn: retiredOn applicationPackageName: applicationPackageName targetAccounts: targetAccounts lastApprovedOn: lastApprovedOn lastPublishedOn: lastPublishedOn lastSubmittedOn: lastSubmittedOn rejectedReason: rejectedReason name: name trialDetails: trial_type: trial_type description: description trial_time_limit: 0.2025324113236393 comment: comment rejectedOn: rejectedOn replicationSchedule: replicationSchedule azureProduct: availabilities: - visibility: visibility enterpriseLicensing: enterpriseLicensing emailAudiences: - description: description id: id - description: description id: id subscriptionAudiences: - description: description id: id - description: description id: id id: id resourceType: resourceType - visibility: visibility enterpriseLicensing: enterpriseLicensing emailAudiences: - description: description id: id - description: description id: id subscriptionAudiences: - description: description id: id - description: description id: id id: id resourceType: resourceType externalIDs: - type: type value: value - type: type value: value variants: - conversionPaths: conversionPaths leadGenID: leadGenID extendedProperties: - type: type value: value - type: type value: value cloudAvailabilities: - cloudAvailabilities - cloudAvailabilities azureGovernmentCertifications: - validationResults: - errorMessage: errorMessage memberNames: - memberNames - memberNames - errorMessage: errorMessage memberNames: - memberNames - memberNames title: title uri: uri - validationResults: - errorMessage: errorMessage memberNames: - memberNames - memberNames - errorMessage: errorMessage memberNames: - memberNames - memberNames title: title uri: uri externalID: externalID referenceVariantID: referenceVariantID id: id state: InActive featureAvailabilities: - markets: - marketCode: marketCode friendlyName: friendlyName - marketCode: marketCode friendlyName: friendlyName visibility: Public priceSchedules: - isBaseSchedule: true schedules: - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true marketCodes: - marketCodes - marketCodes friendlyName: friendlyName - isBaseSchedule: true schedules: - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true marketCodes: - marketCodes - marketCodes friendlyName: friendlyName customMeters: - unitOfMeasure: unitOfMeasure displayName: displayName includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly isEnabled: true priceInUsd: 5.025004791520295 id: id uniqueID: uniqueID - unitOfMeasure: unitOfMeasure displayName: displayName includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly isEnabled: true priceInUsd: 5.025004791520295 id: id uniqueID: uniqueID marketStates: - marketCode: marketCode state: Disabled - marketCode: marketCode state: Disabled tenantAudiences: - description: description id: id - description: description id: id subscriptionAudiences: - description: description id: id - description: description id: id id: id properties: - type: type value: value - type: type value: value trial: duration: 9 dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true type: NoTrial durationType: Minute isHidden: true resourceType: resourceType - markets: - marketCode: marketCode friendlyName: friendlyName - marketCode: marketCode friendlyName: friendlyName visibility: Public priceSchedules: - isBaseSchedule: true schedules: - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true marketCodes: - marketCodes - marketCodes friendlyName: friendlyName - isBaseSchedule: true schedules: - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true marketCodes: - marketCodes - marketCodes friendlyName: friendlyName customMeters: - unitOfMeasure: unitOfMeasure displayName: displayName includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly isEnabled: true priceInUsd: 5.025004791520295 id: id uniqueID: uniqueID - unitOfMeasure: unitOfMeasure displayName: displayName includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly isEnabled: true priceInUsd: 5.025004791520295 id: id uniqueID: uniqueID marketStates: - marketCode: marketCode state: Disabled - marketCode: marketCode state: Disabled tenantAudiences: - description: description id: id - description: description id: id subscriptionAudiences: - description: description id: id - description: description id: id id: id properties: - type: type value: value - type: type value: value trial: duration: 9 dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true type: NoTrial durationType: Minute isHidden: true resourceType: resourceType friendlyName: friendlyName resourceType: AzureSkuVariant - conversionPaths: conversionPaths leadGenID: leadGenID extendedProperties: - type: type value: value - type: type value: value cloudAvailabilities: - cloudAvailabilities - cloudAvailabilities azureGovernmentCertifications: - validationResults: - errorMessage: errorMessage memberNames: - memberNames - memberNames - errorMessage: errorMessage memberNames: - memberNames - memberNames title: title uri: uri - validationResults: - errorMessage: errorMessage memberNames: - memberNames - memberNames - errorMessage: errorMessage memberNames: - memberNames - memberNames title: title uri: uri externalID: externalID referenceVariantID: referenceVariantID id: id state: InActive featureAvailabilities: - markets: - marketCode: marketCode friendlyName: friendlyName - marketCode: marketCode friendlyName: friendlyName visibility: Public priceSchedules: - isBaseSchedule: true schedules: - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true marketCodes: - marketCodes - marketCodes friendlyName: friendlyName - isBaseSchedule: true schedules: - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true marketCodes: - marketCodes - marketCodes friendlyName: friendlyName customMeters: - unitOfMeasure: unitOfMeasure displayName: displayName includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly isEnabled: true priceInUsd: 5.025004791520295 id: id uniqueID: uniqueID - unitOfMeasure: unitOfMeasure displayName: displayName includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly isEnabled: true priceInUsd: 5.025004791520295 id: id uniqueID: uniqueID marketStates: - marketCode: marketCode state: Disabled - marketCode: marketCode state: Disabled tenantAudiences: - description: description id: id - description: description id: id subscriptionAudiences: - description: description id: id - description: description id: id id: id properties: - type: type value: value - type: type value: value trial: duration: 9 dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true type: NoTrial durationType: Minute isHidden: true resourceType: resourceType - markets: - marketCode: marketCode friendlyName: friendlyName - marketCode: marketCode friendlyName: friendlyName visibility: Public priceSchedules: - isBaseSchedule: true schedules: - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true marketCodes: - marketCodes - marketCodes friendlyName: friendlyName - isBaseSchedule: true schedules: - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true marketCodes: - marketCodes - marketCodes friendlyName: friendlyName customMeters: - unitOfMeasure: unitOfMeasure displayName: displayName includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly isEnabled: true priceInUsd: 5.025004791520295 id: id uniqueID: uniqueID - unitOfMeasure: unitOfMeasure displayName: displayName includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly isEnabled: true priceInUsd: 5.025004791520295 id: id uniqueID: uniqueID marketStates: - marketCode: marketCode state: Disabled - marketCode: marketCode state: Disabled tenantAudiences: - description: description id: id - description: description id: id subscriptionAudiences: - description: description id: id - description: description id: id id: id properties: - type: type value: value - type: type value: value trial: duration: 9 dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true type: NoTrial durationType: Minute isHidden: true resourceType: resourceType friendlyName: friendlyName resourceType: AzureSkuVariant branches: - module: module id: id variantID: variantID currentDraftInstanceID: currentDraftInstanceID type: type friendlyName: friendlyName resourceType: resourceType - module: module id: id variantID: variantID currentDraftInstanceID: currentDraftInstanceID type: type friendlyName: friendlyName resourceType: resourceType isModularPublishing: true listings: - summary: summary accessInformation: accessInformation keywords: - keywords - keywords compatibleProducts: - compatibleProducts - compatibleProducts description: description shortDescription: shortDescription languageCode: languageCode title: title gettingStartedInstructions: gettingStartedInstructions assets: - fileName: fileName fileSasUri: fileSasUri description: description id: id state: PendingUpload type: type publisherDefinedSasUri: publisherDefinedSasUri friendlyName: friendlyName order: 4 resourceType: ListingAsset - fileName: fileName fileSasUri: fileSasUri description: description id: id state: PendingUpload type: type publisherDefinedSasUri: publisherDefinedSasUri friendlyName: friendlyName order: 4 resourceType: ListingAsset listingUris: - displayText: displayText subtype: subtype type: type uri: uri - displayText: displayText subtype: subtype type: type uri: uri publisherName: publisherName productDisplayName: productDisplayName listingContacts: - phone: phone name: name type: CustomerSupport uri: uri email: email - phone: phone name: name type: CustomerSupport uri: uri email: email id: id resourceType: AzureListing - summary: summary accessInformation: accessInformation keywords: - keywords - keywords compatibleProducts: - compatibleProducts - compatibleProducts description: description shortDescription: shortDescription languageCode: languageCode title: title gettingStartedInstructions: gettingStartedInstructions assets: - fileName: fileName fileSasUri: fileSasUri description: description id: id state: PendingUpload type: type publisherDefinedSasUri: publisherDefinedSasUri friendlyName: friendlyName order: 4 resourceType: ListingAsset - fileName: fileName fileSasUri: fileSasUri description: description id: id state: PendingUpload type: type publisherDefinedSasUri: publisherDefinedSasUri friendlyName: friendlyName order: 4 resourceType: ListingAsset listingUris: - displayText: displayText subtype: subtype type: type uri: uri - displayText: displayText subtype: subtype type: type uri: uri publisherName: publisherName productDisplayName: productDisplayName listingContacts: - phone: phone name: name type: CustomerSupport uri: uri email: email - phone: phone name: name type: CustomerSupport uri: uri email: email id: id resourceType: AzureListing plans: - lifecycleState: notAvailable product: product softwareReservation: paymentSchedule: type: day value: 7.386281948385884 reservationDuration: type: day value: 7.386281948385884 vmPrices: patternProperties: key: quantity: 7.457744773683766 unitPricePerPaymentPeriodInUsd: 1.1730742509559433 $schema: $schema offerPricingType: '{}' visibility: visible planName: planName resourceName: resourceName id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message plan: plan pricing: customMeters: priceInputOption: perMarket meters: '{}' recurrentPrice: recurrentPriceMode: flatRate userLimits: min: 6.84685269835264 max: 1.4894159098541704 priceInputOption: perMarket prices: - billingFrequency: '{}' pricePerPaymentInUsd: 1.2315135367772556 flexibleSchedule: '{}' contractDuration: '{}' billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency - billingFrequency: '{}' pricePerPaymentInUsd: 1.2315135367772556 flexibleSchedule: '{}' contractDuration: '{}' billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency - lifecycleState: notAvailable product: product softwareReservation: paymentSchedule: type: day value: 7.386281948385884 reservationDuration: type: day value: 7.386281948385884 vmPrices: patternProperties: key: quantity: 7.457744773683766 unitPricePerPaymentPeriodInUsd: 1.1730742509559433 $schema: $schema offerPricingType: '{}' visibility: visible planName: planName resourceName: resourceName id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message plan: plan pricing: customMeters: priceInputOption: perMarket meters: '{}' recurrentPrice: recurrentPriceMode: flatRate userLimits: min: 6.84685269835264 max: 1.4894159098541704 priceInputOption: perMarket prices: - billingFrequency: '{}' pricePerPaymentInUsd: 1.2315135367772556 flexibleSchedule: '{}' contractDuration: '{}' billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency - billingFrequency: '{}' pricePerPaymentInUsd: 1.2315135367772556 flexibleSchedule: '{}' contractDuration: '{}' billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency submissions: - subState: InDraft pendingUpdateInfo: status: status updateType: updateType resources: - type: type value: value - type: type value: value areResourcesReady: true id: id publishedTimeInUtc: 2000-01-23 04:56:07+00:00 state: Inprogress variantResources: - resources: - type: type value: value - type: type value: value variantID: variantID - resources: - type: type value: value - type: type value: value variantID: variantID releaseNumber: 4 targets: - type: type value: value - type: type value: value friendlyName: friendlyName resourceType: Submission - subState: InDraft pendingUpdateInfo: status: status updateType: updateType resources: - type: type value: value - type: type value: value areResourcesReady: true id: id publishedTimeInUtc: 2000-01-23 04:56:07+00:00 state: Inprogress variantResources: - resources: - type: type value: value - type: type value: value variantID: variantID - resources: - type: type value: value - type: type value: value variantID: variantID releaseNumber: 4 targets: - type: type value: value - type: type value: value friendlyName: friendlyName resourceType: Submission name: name packageConfigurations: - landingPageUri: landingPageUri azureActiveDirectoryApplicationID: azureActiveDirectoryApplicationID id: id azureActiveDirectoryTenantID: azureActiveDirectoryTenantID connectionWebhook: connectionWebhook resourceType: AzureSoftwareAsAServicePackageConfiguration - landingPageUri: landingPageUri azureActiveDirectoryApplicationID: azureActiveDirectoryApplicationID id: id azureActiveDirectoryTenantID: azureActiveDirectoryTenantID connectionWebhook: connectionWebhook resourceType: AzureSoftwareAsAServicePackageConfiguration setup: '{}' id: id properties: - appVersion: appVersion useEnterpriseContract: true submissionVersion: submissionVersion customAmendments: - customAmendments - customAmendments extendedProperties: - extendedProperties - extendedProperties termsOfUse: termsOfUse hideKeys: - hideKeys - hideKeys leveledIndustries: key: '' marketingOnlyChange: true globalAmendmentTerms: globalAmendmentTerms industries: - industries - industries additionalCategories: - additionalCategories - additionalCategories applicableProducts: - applicableProducts - applicableProducts leveledCategories: key: '' categories: - categories - categories id: id productTags: - productTags - productTags resourceType: resourceType - appVersion: appVersion useEnterpriseContract: true submissionVersion: submissionVersion customAmendments: - customAmendments - customAmendments extendedProperties: - extendedProperties - extendedProperties termsOfUse: termsOfUse hideKeys: - hideKeys - hideKeys leveledIndustries: key: '' marketingOnlyChange: true globalAmendmentTerms: globalAmendmentTerms industries: - industries - industries additionalCategories: - additionalCategories - additionalCategories applicableProducts: - applicableProducts - applicableProducts leveledCategories: key: '' categories: - categories - categories id: id productTags: - productTags - productTags resourceType: resourceType resourceType: resourceType gcpProduct: revisionId: revisionId marketplace: marketplaces/google-cloud serviceConfig: name: name producerProjectId: producerProjectId metrics: - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 displayUnitDescription: displayUnitDescription unit: unit metricKind: metricKind displayName: displayName valueType: '{}' name: name description: description displayUnit: displayUnit id: id reportingUnit: reportingUnit skuId: skuId - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 displayUnitDescription: displayUnitDescription unit: unit metricKind: metricKind displayName: displayName valueType: '{}' name: name description: description displayUnit: displayUnit id: id reportingUnit: reportingUnit skuId: skuId title: title billing: metrics: - metrics - metrics createTime: 2000-01-23 04:56:07+00:00 service: service listingSpec: marketingSpec: signupUri: signupUri externalLicenseSpecs: - description: description uri: uri - description: description uri: uri searchKeywords: - searchKeywords - searchKeywords tagLine: tagLine displayNames: - displayNames - displayNames externalMarketingUrl: externalMarketingUrl icon: icon description: description searchCategories: - searchCategories - searchCategories searchDescription: searchDescription title: title supportSpec: description: description uri: uri email: email eulaUrl: eulaUrl documentationSpecs: - description: description title: title uri: uri - description: description title: title uri: uri purchaseSpec: features: - name: name description: description title: title - name: name description: description title: title purchaseOptionSpecs: - priceInfo: usageFees: - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 subscriptionPlans: - period: period price: nanos: 1 units: units currencyCode: currencyCode - period: period price: nanos: 1 units: units currencyCode: currencyCode description: description priceModel: FREE purchaseMode: PURCHASE_MODE_PRIVATE name: name title: title featureValues: - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription - priceInfo: usageFees: - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 subscriptionPlans: - period: period price: nanos: 1 units: units currencyCode: currencyCode - period: period price: nanos: 1 units: units currencyCode: currencyCode description: description priceModel: FREE purchaseMode: PURCHASE_MODE_PRIVATE name: name title: title featureValues: - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription metrics: - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 displayUnitDescription: displayUnitDescription unit: unit metricKind: metricKind displayName: displayName valueType: '{}' name: name description: description displayUnit: displayUnit id: id reportingUnit: reportingUnit skuId: skuId - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 displayUnitDescription: displayUnitDescription unit: unit metricKind: metricKind displayName: displayName valueType: '{}' name: name description: description displayUnit: displayUnit id: id reportingUnit: reportingUnit skuId: skuId listingType: BillingIntegratedManagedService termsSpec: standardEula: '{}' inlineEula: '{}' eulaUri: eulaUri externalAccountSpec: signupUri: signupUri loginUri: loginUri singleSignOnUri: singleSignOnUri name: name validationSummary: '{}' lastPublishTime: 2000-01-23 04:56:07+00:00 derivedDiscoveryState: accessState: ALLUSERS_ACCESSIBLE searchState: ADMIN_OVERRIDE_UNSEARCHABLE id: id revisionCreateTime: 2000-01-23 04:56:07+00:00 refundCancellationPolicy: refundCancellationPolicy awsProfessionalServicesProduct: Repositories: - Type: Type Url: Url - Type: Type Url: Url Description: UsW9Submitted: true Highlights: - Highlights - Highlights Categories: - Categories - Categories ProductCode: ProductCode SearchKeywords: - SearchKeywords - SearchKeywords ProductTitle: ProductTitle EuW8Submitted: true ShortDescription: ShortDescription LongDescription: LongDescription Manufacturer: Manufacturer Visibility: Limited AssociatedProducts: '{}' Sku: Sku Registered: true Versions: - CreationDate: 2000-01-23 04:56:07+00:00 Id: Id DeliveryOptions: - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription ReleaseNotes: ReleaseNotes VersionTitle: VersionTitle - CreationDate: 2000-01-23 04:56:07+00:00 Id: Id DeliveryOptions: - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription ReleaseNotes: ReleaseNotes VersionTitle: VersionTitle productId: productId PromotionalResources: AdditionalResources: - Type: Type Text: Text Url: Url - Type: Type Text: Text Url: Url LogoUrl: LogoUrl Videos: - Type: Type Title: Title Url: Url - Type: Type Title: Title Url: Url dataFeedProductId: dataFeedProductId Dimensions: - Types: - Types - Types Description: Description Length: 2 Rate: 6.778324963048013 TimeUnit: DAY Unit: Unit Key: Key Name: Name - Types: - Types - Types Description: Description Length: 2 Rate: 6.778324963048013 TimeUnit: DAY Unit: Unit Key: Key Name: Name SignatureVerificationKeys: - Status: Status PublicKey: PublicKey PublicKeyVersion: 2 - Status: Status PublicKey: PublicKey PublicKeyVersion: 2 SupportInformation: Description: Description commits: - types: - types - types quantity: 4 length: 9 description: description type: '{}' maximumUsers: 361608 rate: 7.386281948385884 isUserCreated: true minimumUsers: 202713 name: name term: term category: category termEndTime: termEndTime key: key timeUnit: '{}' - types: - types - types quantity: 4 length: 9 description: description type: '{}' maximumUsers: 361608 rate: 7.386281948385884 isUserCreated: true minimumUsers: 202713 name: name term: term category: category termEndTime: termEndTime key: key timeUnit: '{}' attributes: key: attributes currency: currency awsMachineLearningProduct: Repositories: - Type: Type Url: Url - Type: Type Url: Url Description: UsW9Submitted: true Highlights: - Highlights - Highlights Categories: - Categories - Categories ProductCode: ProductCode SearchKeywords: - SearchKeywords - SearchKeywords ProductTitle: ProductTitle EuW8Submitted: true ShortDescription: ShortDescription LongDescription: LongDescription Manufacturer: Manufacturer Visibility: Limited AssociatedProducts: '{}' Sku: Sku Registered: true Versions: - CreationDate: 2000-01-23 04:56:07+00:00 Id: Id DeliveryOptions: - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription ReleaseNotes: ReleaseNotes VersionTitle: VersionTitle - CreationDate: 2000-01-23 04:56:07+00:00 Id: Id DeliveryOptions: - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription ReleaseNotes: ReleaseNotes VersionTitle: VersionTitle productId: productId PromotionalResources: AdditionalResources: - Type: Type Text: Text Url: Url - Type: Type Text: Text Url: Url LogoUrl: LogoUrl Videos: - Type: Type Title: Title Url: Url - Type: Type Title: Title Url: Url dataFeedProductId: dataFeedProductId Dimensions: - Types: - Types - Types Description: Description Length: 2 Rate: 6.778324963048013 TimeUnit: DAY Unit: Unit Key: Key Name: Name - Types: - Types - Types Description: Description Length: 2 Rate: 6.778324963048013 TimeUnit: DAY Unit: Unit Key: Key Name: Name SignatureVerificationKeys: - Status: Status PublicKey: PublicKey PublicKeyVersion: 2 - Status: Status PublicKey: PublicKey PublicKeyVersion: 2 SupportInformation: Description: Description stripeProduct: images: - images - images metadata: key: metadata livemode: true created: 6 active: true description: description url: url package_dimensions: '{}' statement_descriptor: statement_descriptor marketing_features: - name: name - name: name tax_code: '{}' shippable: true name: name id: id unit_label: unit_label updated: 4 object: object dimensions: - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 types: - types - types description: description planName: planName usageCount: '{}' rate: 6.84685269835264 includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly valueType: '{}' name: name planId: planId category: category key: key skuId: skuId - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 types: - types - types description: description planName: planName usageCount: '{}' rate: 6.84685269835264 includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly valueType: '{}' name: name planId: planId category: category key: key skuId: skuId properties: alibabaProduct: $ref: '#/components/schemas/AlibabaMarketplaceProduct' attributes: additionalProperties: type: string type: object awsAmiProduct: $ref: '#/components/schemas/AwsProduct' awsContainerProduct: $ref: '#/components/schemas/AwsProduct' awsMachineLearningProduct: $ref: '#/components/schemas/AwsProduct' awsProfessionalServicesProduct: $ref: '#/components/schemas/AwsProduct' awsSaasProduct: $ref: '#/components/schemas/AwsProduct' awsSnsSubscriptions: items: $ref: '#/components/schemas/AwsSnsSubscription' type: array azureProduct: $ref: '#/components/schemas/AzureProduct' azureProductResource: $ref: '#/components/schemas/AzureMarketplaceProductResource' commits: items: $ref: '#/components/schemas/CommitDimension' type: array currency: type: string dimensions: items: $ref: '#/components/schemas/MeteringDimension' type: array eulaType: allOf: - $ref: '#/components/schemas/EulaType' description: The public offer's EULA type. type: object eulaUrl: description: The public offer's EULA URL. type: string gcpProduct: $ref: '#/components/schemas/GcpMarketplaceProduct' refundCancellationPolicy: type: string sellerNotes: type: string snowflakeProduct: $ref: '#/components/schemas/SnowflakeMarketplaceProduct' stripeProduct: $ref: '#/components/schemas/StripeProduct' type: object RevenueChannel: enum: - DIRECT - RESOLD type: string x-enum-varnames: - RevenueChannelDirect - RevenueChannelResold RevenueRecord: example: date: 2000-01-23 04:56:07+00:00 amount: 0.8008281904610115 productID: productID refundDisburseAmount: 9.965781217890562 entitlementID: entitlementID invoiceAmount: 5.025004791520295 buyerID: buyerID invoiceDate: 2000-01-23 04:56:07+00:00 collectableAmount: 6.027456183070403 disburseDate: 2000-01-23 04:56:07+00:00 refundInvoiceDate: 2000-01-23 04:56:07+00:00 refundDisburseDate: 2000-01-23 04:56:07+00:00 organizationID: organizationID paymentDueDate: 2000-01-23 04:56:07+00:00 refundInvoiceAmount: 9.369310271410669 partner: partner currency: currency disburseAmount: 1.4658129805029452 id: id taxAmount: 6.683562403749608 info: awsRevenueRecords: - brokerID: brokerID usagePeriodStartDate: valid: true time: time productID: productID insertDate: valid: true time: time toAccountID: toAccountID usagePeriodEndDate: valid: true time: time parentBillingEventID: parentBillingEventID disbursementBillingEventID: disbursementBillingEventID action: action offerID: offerID currency: currency invoiceID: invoiceID id: id balanceImpacting: 5 amount: 5.962133916683182 endUserAccountID: endUserAccountID dataFeedProductID: dataFeedProductID entitlementID: entitlementID buyerID: buyerID invoiceDate: valid: true time: time transactionReferenceID: transactionReferenceID organizationID: organizationID transactionType: transactionType paymentDueDate: valid: true time: time fromAccountID: fromAccountID agreementID: agreementID billingAddressID: billingAddressID bankTraceID: bankTraceID - brokerID: brokerID usagePeriodStartDate: valid: true time: time productID: productID insertDate: valid: true time: time toAccountID: toAccountID usagePeriodEndDate: valid: true time: time parentBillingEventID: parentBillingEventID disbursementBillingEventID: disbursementBillingEventID action: action offerID: offerID currency: currency invoiceID: invoiceID id: id balanceImpacting: 5 amount: 5.962133916683182 endUserAccountID: endUserAccountID dataFeedProductID: dataFeedProductID entitlementID: entitlementID buyerID: buyerID invoiceDate: valid: true time: time transactionReferenceID: transactionReferenceID organizationID: organizationID transactionType: transactionType paymentDueDate: valid: true time: time fromAccountID: fromAccountID agreementID: agreementID billingAddressID: billingAddressID bankTraceID: bankTraceID resellerName: resellerName resource: resource billingModel: SubscriptionBased channel: '{}' idSource: idSource earningId: earningId resellerId: resellerId disbursementNotificationSent: true azureRevenueRecords: - purchaseRecordID: purchaseRecordID productID: productID termEndDate: termEndDate azureCustomerID: azureCustomerID billingModel: billingModel payoutStatus: payoutStatus resellerCity: resellerCity resellerID: resellerID programName: programName resellerState: resellerState azureAssetID: azureAssetID offerID: offerID earningUsd: 2.3021358869347655 invoiceID: invoiceID azurePlanID: azurePlanID paymentStatus: paymentStatus revenueUsd: 7.061401241503109 azureBillingAccountID: azureBillingAccountID entitlementID: entitlementID resellerEmail: resellerEmail buyerID: buyerID invoiceDate: valid: true time: time transactionDate: valid: true time: time earningID: earningID invoiceDueDate: valid: true time: time resellerCompany: resellerCompany organizationID: organizationID resellerCountry: resellerCountry paymentID: paymentID termStartDate: termStartDate azureOfferID: azureOfferID estimatedPayoutMonth: valid: true time: time paymentSentDate: valid: true time: time - purchaseRecordID: purchaseRecordID productID: productID termEndDate: termEndDate azureCustomerID: azureCustomerID billingModel: billingModel payoutStatus: payoutStatus resellerCity: resellerCity resellerID: resellerID programName: programName resellerState: resellerState azureAssetID: azureAssetID offerID: offerID earningUsd: 2.3021358869347655 invoiceID: invoiceID azurePlanID: azurePlanID paymentStatus: paymentStatus revenueUsd: 7.061401241503109 azureBillingAccountID: azureBillingAccountID entitlementID: entitlementID resellerEmail: resellerEmail buyerID: buyerID invoiceDate: valid: true time: time transactionDate: valid: true time: time earningID: earningID invoiceDueDate: valid: true time: time resellerCompany: resellerCompany organizationID: organizationID resellerCountry: resellerCountry paymentID: paymentID termStartDate: termStartDate azureOfferID: azureOfferID estimatedPayoutMonth: valid: true time: time paymentSentDate: valid: true time: time paymentId: paymentId disbursementBillingEventId: disbursementBillingEventId bankTraceId: bankTraceId creditAmount: 9.301444243932576 gcpRevenueRecords: - productID: productID usage: 1.1730742509559433 withheld: 4.965218492984954 paymentType: paymentType accountID: accountID refundBalanceOutstanding: 1.4894159098541704 reportDate: reportDate trialUse: 7.457744773683766 paymentSchedule: paymentSchedule offerID: offerID currency: currency prepayCredits: 1.2315135367772556 abandoned: 3.616076749251911 sku: sku released: 6.84685269835264 usedBy: usedBy insightAccountID: insightAccountID dueVendor: 4.145608029883936 resource: resource googleEntity: googleEntity refundReason: refundReason entitlementID: entitlementID buyerID: buyerID organizationID: organizationID charges: 2.027123023002322 unit: unit refundBalanceDeductedThisMonth: 1.0246457001441578 ordinal: 7 - productID: productID usage: 1.1730742509559433 withheld: 4.965218492984954 paymentType: paymentType accountID: accountID refundBalanceOutstanding: 1.4894159098541704 reportDate: reportDate trialUse: 7.457744773683766 paymentSchedule: paymentSchedule offerID: offerID currency: currency prepayCredits: 1.2315135367772556 abandoned: 3.616076749251911 sku: sku released: 6.84685269835264 usedBy: usedBy insightAccountID: insightAccountID dueVendor: 4.145608029883936 resource: resource googleEntity: googleEntity refundReason: refundReason entitlementID: entitlementID buyerID: buyerID organizationID: organizationID charges: 2.027123023002322 unit: unit refundBalanceDeductedThisMonth: 1.0246457001441578 ordinal: 7 properties: amount: description: The revenue amount for the revenue report type: number buyerID: type: string collectableAmount: description: The revenue amount that the seller/ISV can collect. type: number currency: description: The currency of the revenue in ISO 4217 format, such as "USD". type: string date: description: The date for the revenue report format: date-time type: string disburseAmount: type: number disburseDate: format: date-time type: string entitlementID: type: string id: type: string info: $ref: '#/components/schemas/RevenueRecordInfo' invoiceAmount: type: number invoiceDate: format: date-time type: string organizationID: type: string partner: description: The value is from type Partner string type: string paymentDueDate: format: date-time type: string productID: type: string refundDisburseAmount: type: number refundDisburseDate: format: date-time type: string refundInvoiceAmount: type: number refundInvoiceDate: format: date-time type: string taxAmount: type: number type: object RevenueRecordDetail: example: awsRevenueRecordDetail: '{}' gcpRevenueRecordDetail: '{}' azureRevenueRecordDetail: '{}' properties: awsRevenueRecordDetail: allOf: - $ref: '#/components/schemas/github_com_sugerio_marketplace-service_pkg_legacy_rds-db_lib.BillingAwsBillingEvent' description: For AWS Marketplace type: object azureRevenueRecordDetail: allOf: - $ref: '#/components/schemas/github_com_sugerio_marketplace-service_pkg_legacy_rds-db_lib.BillingAzureCmaRevenue' description: For Azure Marketplace type: object gcpRevenueRecordDetail: allOf: - $ref: '#/components/schemas/github_com_sugerio_marketplace-service_pkg_legacy_rds-db_lib.BillingGcpChargeUsage' description: For GCP Marketplace type: object type: object RevenueRecordInfo: example: awsRevenueRecords: - brokerID: brokerID usagePeriodStartDate: valid: true time: time productID: productID insertDate: valid: true time: time toAccountID: toAccountID usagePeriodEndDate: valid: true time: time parentBillingEventID: parentBillingEventID disbursementBillingEventID: disbursementBillingEventID action: action offerID: offerID currency: currency invoiceID: invoiceID id: id balanceImpacting: 5 amount: 5.962133916683182 endUserAccountID: endUserAccountID dataFeedProductID: dataFeedProductID entitlementID: entitlementID buyerID: buyerID invoiceDate: valid: true time: time transactionReferenceID: transactionReferenceID organizationID: organizationID transactionType: transactionType paymentDueDate: valid: true time: time fromAccountID: fromAccountID agreementID: agreementID billingAddressID: billingAddressID bankTraceID: bankTraceID - brokerID: brokerID usagePeriodStartDate: valid: true time: time productID: productID insertDate: valid: true time: time toAccountID: toAccountID usagePeriodEndDate: valid: true time: time parentBillingEventID: parentBillingEventID disbursementBillingEventID: disbursementBillingEventID action: action offerID: offerID currency: currency invoiceID: invoiceID id: id balanceImpacting: 5 amount: 5.962133916683182 endUserAccountID: endUserAccountID dataFeedProductID: dataFeedProductID entitlementID: entitlementID buyerID: buyerID invoiceDate: valid: true time: time transactionReferenceID: transactionReferenceID organizationID: organizationID transactionType: transactionType paymentDueDate: valid: true time: time fromAccountID: fromAccountID agreementID: agreementID billingAddressID: billingAddressID bankTraceID: bankTraceID resellerName: resellerName resource: resource billingModel: SubscriptionBased channel: '{}' idSource: idSource earningId: earningId resellerId: resellerId disbursementNotificationSent: true azureRevenueRecords: - purchaseRecordID: purchaseRecordID productID: productID termEndDate: termEndDate azureCustomerID: azureCustomerID billingModel: billingModel payoutStatus: payoutStatus resellerCity: resellerCity resellerID: resellerID programName: programName resellerState: resellerState azureAssetID: azureAssetID offerID: offerID earningUsd: 2.3021358869347655 invoiceID: invoiceID azurePlanID: azurePlanID paymentStatus: paymentStatus revenueUsd: 7.061401241503109 azureBillingAccountID: azureBillingAccountID entitlementID: entitlementID resellerEmail: resellerEmail buyerID: buyerID invoiceDate: valid: true time: time transactionDate: valid: true time: time earningID: earningID invoiceDueDate: valid: true time: time resellerCompany: resellerCompany organizationID: organizationID resellerCountry: resellerCountry paymentID: paymentID termStartDate: termStartDate azureOfferID: azureOfferID estimatedPayoutMonth: valid: true time: time paymentSentDate: valid: true time: time - purchaseRecordID: purchaseRecordID productID: productID termEndDate: termEndDate azureCustomerID: azureCustomerID billingModel: billingModel payoutStatus: payoutStatus resellerCity: resellerCity resellerID: resellerID programName: programName resellerState: resellerState azureAssetID: azureAssetID offerID: offerID earningUsd: 2.3021358869347655 invoiceID: invoiceID azurePlanID: azurePlanID paymentStatus: paymentStatus revenueUsd: 7.061401241503109 azureBillingAccountID: azureBillingAccountID entitlementID: entitlementID resellerEmail: resellerEmail buyerID: buyerID invoiceDate: valid: true time: time transactionDate: valid: true time: time earningID: earningID invoiceDueDate: valid: true time: time resellerCompany: resellerCompany organizationID: organizationID resellerCountry: resellerCountry paymentID: paymentID termStartDate: termStartDate azureOfferID: azureOfferID estimatedPayoutMonth: valid: true time: time paymentSentDate: valid: true time: time paymentId: paymentId disbursementBillingEventId: disbursementBillingEventId bankTraceId: bankTraceId creditAmount: 9.301444243932576 gcpRevenueRecords: - productID: productID usage: 1.1730742509559433 withheld: 4.965218492984954 paymentType: paymentType accountID: accountID refundBalanceOutstanding: 1.4894159098541704 reportDate: reportDate trialUse: 7.457744773683766 paymentSchedule: paymentSchedule offerID: offerID currency: currency prepayCredits: 1.2315135367772556 abandoned: 3.616076749251911 sku: sku released: 6.84685269835264 usedBy: usedBy insightAccountID: insightAccountID dueVendor: 4.145608029883936 resource: resource googleEntity: googleEntity refundReason: refundReason entitlementID: entitlementID buyerID: buyerID organizationID: organizationID charges: 2.027123023002322 unit: unit refundBalanceDeductedThisMonth: 1.0246457001441578 ordinal: 7 - productID: productID usage: 1.1730742509559433 withheld: 4.965218492984954 paymentType: paymentType accountID: accountID refundBalanceOutstanding: 1.4894159098541704 reportDate: reportDate trialUse: 7.457744773683766 paymentSchedule: paymentSchedule offerID: offerID currency: currency prepayCredits: 1.2315135367772556 abandoned: 3.616076749251911 sku: sku released: 6.84685269835264 usedBy: usedBy insightAccountID: insightAccountID dueVendor: 4.145608029883936 resource: resource googleEntity: googleEntity refundReason: refundReason entitlementID: entitlementID buyerID: buyerID organizationID: organizationID charges: 2.027123023002322 unit: unit refundBalanceDeductedThisMonth: 1.0246457001441578 ordinal: 7 properties: awsRevenueRecords: description: For raw revenue records in AWS Marketplace items: $ref: '#/components/schemas/github_com_sugerio_marketplace-service_pkg_legacy_rds-db_lib.BillingAwsBillingEvent' type: array azureRevenueRecords: description: For raw revenue records in Azure Marketplace items: $ref: '#/components/schemas/github_com_sugerio_marketplace-service_pkg_legacy_rds-db_lib.BillingAzureCmaRevenue' type: array bankTraceId: description: The bank trace ID of the revenue record if applicable type: string billingModel: description: 'The billing model of the revenue record if applicable The value is one of the following: - SubscriptionBased: The revenue record is from a subscription or recurring commitment. - UsageBased: The revenue record is from a usage-based metering.' enum: - SubscriptionBased - UsageBased type: string channel: allOf: - $ref: '#/components/schemas/RevenueChannel' description: The channel of revenue record. type: object creditAmount: description: The credit amount used in the revenue record. type: number disbursementBillingEventId: description: The disbursement ID of the revenue record if applicable type: string disbursementNotificationSent: description: Whether the disbursement notification has been sent to the seller/ISV. type: boolean earningId: description: The earning ID of the revenue record if applicable type: string gcpRevenueRecords: description: For raw revenue records in GCP Marketplace items: $ref: '#/components/schemas/github_com_sugerio_marketplace-service_pkg_legacy_rds-db_lib.BillingGcpChargeUsage' type: array idSource: description: Source of the revenue record ID. type: string paymentId: description: The payment ID of the revenue record if applicable type: string resellerId: description: The reseller ID of the revenue record if applicable type: string resellerName: description: The reseller name of the revenue record if application type: string resource: description: Resource name for the revenue record. Applicable only to GCP Marketplace. type: string type: object RevenueReport: example: organizationID: organizationID reportType: GrossAmount partner: partner productID: productID reportDate: 2000-01-23 04:56:07+00:00 service: service entitlementID: entitlementID groupBy: '{}' revenueRecords: - date: 2000-01-23 04:56:07+00:00 amount: 0.8008281904610115 productID: productID refundDisburseAmount: 9.965781217890562 entitlementID: entitlementID invoiceAmount: 5.025004791520295 buyerID: buyerID invoiceDate: 2000-01-23 04:56:07+00:00 collectableAmount: 6.027456183070403 disburseDate: 2000-01-23 04:56:07+00:00 refundInvoiceDate: 2000-01-23 04:56:07+00:00 refundDisburseDate: 2000-01-23 04:56:07+00:00 organizationID: organizationID paymentDueDate: 2000-01-23 04:56:07+00:00 refundInvoiceAmount: 9.369310271410669 partner: partner currency: currency disburseAmount: 1.4658129805029452 id: id taxAmount: 6.683562403749608 info: awsRevenueRecords: - brokerID: brokerID usagePeriodStartDate: valid: true time: time productID: productID insertDate: valid: true time: time toAccountID: toAccountID usagePeriodEndDate: valid: true time: time parentBillingEventID: parentBillingEventID disbursementBillingEventID: disbursementBillingEventID action: action offerID: offerID currency: currency invoiceID: invoiceID id: id balanceImpacting: 5 amount: 5.962133916683182 endUserAccountID: endUserAccountID dataFeedProductID: dataFeedProductID entitlementID: entitlementID buyerID: buyerID invoiceDate: valid: true time: time transactionReferenceID: transactionReferenceID organizationID: organizationID transactionType: transactionType paymentDueDate: valid: true time: time fromAccountID: fromAccountID agreementID: agreementID billingAddressID: billingAddressID bankTraceID: bankTraceID - brokerID: brokerID usagePeriodStartDate: valid: true time: time productID: productID insertDate: valid: true time: time toAccountID: toAccountID usagePeriodEndDate: valid: true time: time parentBillingEventID: parentBillingEventID disbursementBillingEventID: disbursementBillingEventID action: action offerID: offerID currency: currency invoiceID: invoiceID id: id balanceImpacting: 5 amount: 5.962133916683182 endUserAccountID: endUserAccountID dataFeedProductID: dataFeedProductID entitlementID: entitlementID buyerID: buyerID invoiceDate: valid: true time: time transactionReferenceID: transactionReferenceID organizationID: organizationID transactionType: transactionType paymentDueDate: valid: true time: time fromAccountID: fromAccountID agreementID: agreementID billingAddressID: billingAddressID bankTraceID: bankTraceID resellerName: resellerName resource: resource billingModel: SubscriptionBased channel: '{}' idSource: idSource earningId: earningId resellerId: resellerId disbursementNotificationSent: true azureRevenueRecords: - purchaseRecordID: purchaseRecordID productID: productID termEndDate: termEndDate azureCustomerID: azureCustomerID billingModel: billingModel payoutStatus: payoutStatus resellerCity: resellerCity resellerID: resellerID programName: programName resellerState: resellerState azureAssetID: azureAssetID offerID: offerID earningUsd: 2.3021358869347655 invoiceID: invoiceID azurePlanID: azurePlanID paymentStatus: paymentStatus revenueUsd: 7.061401241503109 azureBillingAccountID: azureBillingAccountID entitlementID: entitlementID resellerEmail: resellerEmail buyerID: buyerID invoiceDate: valid: true time: time transactionDate: valid: true time: time earningID: earningID invoiceDueDate: valid: true time: time resellerCompany: resellerCompany organizationID: organizationID resellerCountry: resellerCountry paymentID: paymentID termStartDate: termStartDate azureOfferID: azureOfferID estimatedPayoutMonth: valid: true time: time paymentSentDate: valid: true time: time - purchaseRecordID: purchaseRecordID productID: productID termEndDate: termEndDate azureCustomerID: azureCustomerID billingModel: billingModel payoutStatus: payoutStatus resellerCity: resellerCity resellerID: resellerID programName: programName resellerState: resellerState azureAssetID: azureAssetID offerID: offerID earningUsd: 2.3021358869347655 invoiceID: invoiceID azurePlanID: azurePlanID paymentStatus: paymentStatus revenueUsd: 7.061401241503109 azureBillingAccountID: azureBillingAccountID entitlementID: entitlementID resellerEmail: resellerEmail buyerID: buyerID invoiceDate: valid: true time: time transactionDate: valid: true time: time earningID: earningID invoiceDueDate: valid: true time: time resellerCompany: resellerCompany organizationID: organizationID resellerCountry: resellerCountry paymentID: paymentID termStartDate: termStartDate azureOfferID: azureOfferID estimatedPayoutMonth: valid: true time: time paymentSentDate: valid: true time: time paymentId: paymentId disbursementBillingEventId: disbursementBillingEventId bankTraceId: bankTraceId creditAmount: 9.301444243932576 gcpRevenueRecords: - productID: productID usage: 1.1730742509559433 withheld: 4.965218492984954 paymentType: paymentType accountID: accountID refundBalanceOutstanding: 1.4894159098541704 reportDate: reportDate trialUse: 7.457744773683766 paymentSchedule: paymentSchedule offerID: offerID currency: currency prepayCredits: 1.2315135367772556 abandoned: 3.616076749251911 sku: sku released: 6.84685269835264 usedBy: usedBy insightAccountID: insightAccountID dueVendor: 4.145608029883936 resource: resource googleEntity: googleEntity refundReason: refundReason entitlementID: entitlementID buyerID: buyerID organizationID: organizationID charges: 2.027123023002322 unit: unit refundBalanceDeductedThisMonth: 1.0246457001441578 ordinal: 7 - productID: productID usage: 1.1730742509559433 withheld: 4.965218492984954 paymentType: paymentType accountID: accountID refundBalanceOutstanding: 1.4894159098541704 reportDate: reportDate trialUse: 7.457744773683766 paymentSchedule: paymentSchedule offerID: offerID currency: currency prepayCredits: 1.2315135367772556 abandoned: 3.616076749251911 sku: sku released: 6.84685269835264 usedBy: usedBy insightAccountID: insightAccountID dueVendor: 4.145608029883936 resource: resource googleEntity: googleEntity refundReason: refundReason entitlementID: entitlementID buyerID: buyerID organizationID: organizationID charges: 2.027123023002322 unit: unit refundBalanceDeductedThisMonth: 1.0246457001441578 ordinal: 7 - date: 2000-01-23 04:56:07+00:00 amount: 0.8008281904610115 productID: productID refundDisburseAmount: 9.965781217890562 entitlementID: entitlementID invoiceAmount: 5.025004791520295 buyerID: buyerID invoiceDate: 2000-01-23 04:56:07+00:00 collectableAmount: 6.027456183070403 disburseDate: 2000-01-23 04:56:07+00:00 refundInvoiceDate: 2000-01-23 04:56:07+00:00 refundDisburseDate: 2000-01-23 04:56:07+00:00 organizationID: organizationID paymentDueDate: 2000-01-23 04:56:07+00:00 refundInvoiceAmount: 9.369310271410669 partner: partner currency: currency disburseAmount: 1.4658129805029452 id: id taxAmount: 6.683562403749608 info: awsRevenueRecords: - brokerID: brokerID usagePeriodStartDate: valid: true time: time productID: productID insertDate: valid: true time: time toAccountID: toAccountID usagePeriodEndDate: valid: true time: time parentBillingEventID: parentBillingEventID disbursementBillingEventID: disbursementBillingEventID action: action offerID: offerID currency: currency invoiceID: invoiceID id: id balanceImpacting: 5 amount: 5.962133916683182 endUserAccountID: endUserAccountID dataFeedProductID: dataFeedProductID entitlementID: entitlementID buyerID: buyerID invoiceDate: valid: true time: time transactionReferenceID: transactionReferenceID organizationID: organizationID transactionType: transactionType paymentDueDate: valid: true time: time fromAccountID: fromAccountID agreementID: agreementID billingAddressID: billingAddressID bankTraceID: bankTraceID - brokerID: brokerID usagePeriodStartDate: valid: true time: time productID: productID insertDate: valid: true time: time toAccountID: toAccountID usagePeriodEndDate: valid: true time: time parentBillingEventID: parentBillingEventID disbursementBillingEventID: disbursementBillingEventID action: action offerID: offerID currency: currency invoiceID: invoiceID id: id balanceImpacting: 5 amount: 5.962133916683182 endUserAccountID: endUserAccountID dataFeedProductID: dataFeedProductID entitlementID: entitlementID buyerID: buyerID invoiceDate: valid: true time: time transactionReferenceID: transactionReferenceID organizationID: organizationID transactionType: transactionType paymentDueDate: valid: true time: time fromAccountID: fromAccountID agreementID: agreementID billingAddressID: billingAddressID bankTraceID: bankTraceID resellerName: resellerName resource: resource billingModel: SubscriptionBased channel: '{}' idSource: idSource earningId: earningId resellerId: resellerId disbursementNotificationSent: true azureRevenueRecords: - purchaseRecordID: purchaseRecordID productID: productID termEndDate: termEndDate azureCustomerID: azureCustomerID billingModel: billingModel payoutStatus: payoutStatus resellerCity: resellerCity resellerID: resellerID programName: programName resellerState: resellerState azureAssetID: azureAssetID offerID: offerID earningUsd: 2.3021358869347655 invoiceID: invoiceID azurePlanID: azurePlanID paymentStatus: paymentStatus revenueUsd: 7.061401241503109 azureBillingAccountID: azureBillingAccountID entitlementID: entitlementID resellerEmail: resellerEmail buyerID: buyerID invoiceDate: valid: true time: time transactionDate: valid: true time: time earningID: earningID invoiceDueDate: valid: true time: time resellerCompany: resellerCompany organizationID: organizationID resellerCountry: resellerCountry paymentID: paymentID termStartDate: termStartDate azureOfferID: azureOfferID estimatedPayoutMonth: valid: true time: time paymentSentDate: valid: true time: time - purchaseRecordID: purchaseRecordID productID: productID termEndDate: termEndDate azureCustomerID: azureCustomerID billingModel: billingModel payoutStatus: payoutStatus resellerCity: resellerCity resellerID: resellerID programName: programName resellerState: resellerState azureAssetID: azureAssetID offerID: offerID earningUsd: 2.3021358869347655 invoiceID: invoiceID azurePlanID: azurePlanID paymentStatus: paymentStatus revenueUsd: 7.061401241503109 azureBillingAccountID: azureBillingAccountID entitlementID: entitlementID resellerEmail: resellerEmail buyerID: buyerID invoiceDate: valid: true time: time transactionDate: valid: true time: time earningID: earningID invoiceDueDate: valid: true time: time resellerCompany: resellerCompany organizationID: organizationID resellerCountry: resellerCountry paymentID: paymentID termStartDate: termStartDate azureOfferID: azureOfferID estimatedPayoutMonth: valid: true time: time paymentSentDate: valid: true time: time paymentId: paymentId disbursementBillingEventId: disbursementBillingEventId bankTraceId: bankTraceId creditAmount: 9.301444243932576 gcpRevenueRecords: - productID: productID usage: 1.1730742509559433 withheld: 4.965218492984954 paymentType: paymentType accountID: accountID refundBalanceOutstanding: 1.4894159098541704 reportDate: reportDate trialUse: 7.457744773683766 paymentSchedule: paymentSchedule offerID: offerID currency: currency prepayCredits: 1.2315135367772556 abandoned: 3.616076749251911 sku: sku released: 6.84685269835264 usedBy: usedBy insightAccountID: insightAccountID dueVendor: 4.145608029883936 resource: resource googleEntity: googleEntity refundReason: refundReason entitlementID: entitlementID buyerID: buyerID organizationID: organizationID charges: 2.027123023002322 unit: unit refundBalanceDeductedThisMonth: 1.0246457001441578 ordinal: 7 - productID: productID usage: 1.1730742509559433 withheld: 4.965218492984954 paymentType: paymentType accountID: accountID refundBalanceOutstanding: 1.4894159098541704 reportDate: reportDate trialUse: 7.457744773683766 paymentSchedule: paymentSchedule offerID: offerID currency: currency prepayCredits: 1.2315135367772556 abandoned: 3.616076749251911 sku: sku released: 6.84685269835264 usedBy: usedBy insightAccountID: insightAccountID dueVendor: 4.145608029883936 resource: resource googleEntity: googleEntity refundReason: refundReason entitlementID: entitlementID buyerID: buyerID organizationID: organizationID charges: 2.027123023002322 unit: unit refundBalanceDeductedThisMonth: 1.0246457001441578 ordinal: 7 buyerID: buyerID properties: buyerID: type: string entitlementID: type: string groupBy: allOf: - $ref: '#/components/schemas/GroupByInterval' description: The group by of the revenue report. type: object organizationID: type: string partner: type: string productID: type: string reportDate: format: date-time type: string reportType: $ref: '#/components/schemas/RevenueReportType' revenueRecords: items: $ref: '#/components/schemas/RevenueRecord' type: array service: type: string type: object RevenueReportType: enum: - GrossAmount - InvoicedAmount - CollectableAmount - DisbursedAmount type: string x-enum-varnames: - RevenueReportType_GrossAmount - RevenueReportType_InvoicedAmount - RevenueReportType_CollectableAmount - RevenueReportType_DisbursedAmount SnowflakeMarketplaceBuyer: properties: snowflakeCustomerID: description: The customer ID of the buyer in Snowflake Marketplace. type: string type: object SnowflakeMarketplaceOffer: properties: access_end_time: type: string access_start_date_preference: type: string access_start_time: type: string additional_information: type: string comment: type: string contract_duration_months: type: integer contract_type: type: string contract_value: type: string discount: type: number display_name: type: string expiration_time: type: string invoice_start_date_preference: description: 'invoice start date preference: FIRST_DAY_NEXT_MONTH, OFFER_ACCEPTED_DATE' type: string invoice_start_time: type: string is_default: type: boolean name: type: string payment_terms: $ref: '#/components/schemas/SnowflakeMarketplaceOfferPaymentTerms' pricing_plan_name: type: string state: type: string state_updated_on: type: string target_consumer: type: string terms_of_service: allOf: - $ref: '#/components/schemas/SnowflakeMarketplaceOfferTermsOfService' description: 'terms of service: {"type":"DEFAULT"}' type: object updated_on: type: string type: object SnowflakeMarketplaceOfferPaymentTerms: properties: installment_schedule: allOf: - $ref: '#/components/schemas/SnowflakeMarketplacePlanInstallmentSchedule' description: The installment schedule for the offer. type: object payment_type: description: The pricing plan payment types. Accepted values are INVOICE, CREDIT_CARD, INSTALLMENT. enum: - INVOICE - CREDIT_CARD - INSTALLMENT type: string type: object SnowflakeMarketplaceOfferTermsOfService: properties: custom_link: type: string type: type: string type: object SnowflakeMarketplacePlanInstallment: example: installment_amount: 4.652396432933246 installment_number: 8.969578798196912 properties: installment_amount: type: number installment_number: type: number type: object SnowflakeMarketplacePlanInstallmentSchedule: example: default_installment_amount: 6.519180951018382 overridden_installments: - installment_amount: 4.652396432933246 installment_number: 8.969578798196912 - installment_amount: 4.652396432933246 installment_number: 8.969578798196912 installment_duration: 0.10263654006109402 properties: default_installment_amount: type: number installment_duration: type: number overridden_installments: items: $ref: '#/components/schemas/SnowflakeMarketplacePlanInstallment' type: array type: object SnowflakeMarketplacePricingPlanUsageDetails: example: free_unit_kind: free_unit_kind free_units: 5.533258397034986 usage_unit_kind: usage_unit_kind max_fee: 3.2588565619047607 usage_unit_price: 4.078845849666752 properties: free_unit_kind: type: string free_units: type: number max_fee: type: number usage_unit_kind: type: string usage_unit_price: type: number type: object SnowflakeMarketplaceProduct: example: profileName: profileName evaluationPlan: evaluationPlan metadata: hasFreeSampleData: true areTermsProvidedOffline: true usage: '{}' description: description businessNeeds: '{}' share: share paidAttributes: '{}' title: title isWithStandardTerms: true private: true additionalRegions: additionalRegions globalName: globalName regions: regions autofulfillment: true flags: flags pricingPlans: - updated_on: updated_on billing_duration_months: '0' metadata: key: metadata visibility: visibility display_name: display_name usage_details: free_unit_kind: free_unit_kind free_units: 5.533258397034986 usage_unit_kind: usage_unit_kind max_fee: 3.2588565619047607 usage_unit_price: 4.078845849666752 base_fee: 7.04836565559697 contract_type: contract_type sales_motion: sales_motion pricing_model: pricing_model name: name comment: comment currency: currency state: state contract_duration_months: '0' - updated_on: updated_on billing_duration_months: '0' metadata: key: metadata visibility: visibility display_name: display_name usage_details: free_unit_kind: free_unit_kind free_units: 5.533258397034986 usage_unit_kind: usage_unit_kind max_fee: 3.2588565619047607 usage_unit_price: 4.078845849666752 base_fee: 7.04836565559697 contract_type: contract_type sales_motion: sales_motion pricing_model: pricing_model name: name comment: comment currency: currency state: state contract_duration_months: '0' listingType: listingType distribution: distribution createdOn: createdOn customizedContactInfo: customizedContactInfo fulfillmentType: fulfillmentType shareType: shareType unpublishedByAdminReason: unpublishedByAdminReason scheduledDropTime: scheduledDropTime firstPublishedOn: firstPublishedOn isMountlessQueryable: true state: state attachedShare: attachedShare detailedTargetAccounts: - company_name: company_name account_identifier: account_identifier - company_name: company_name account_identifier: account_identifier publishOnApproval: true defaultPricingPlan: free_unit_kind: free_unit_kind trial_usage_unit: trial_usage_unit usage_unit_kind: usage_unit_kind is_auto_renewable: true installment_schedule: default_installment_amount: 6.519180951018382 overridden_installments: - installment_amount: 4.652396432933246 installment_number: 8.969578798196912 - installment_amount: 4.652396432933246 installment_number: 8.969578798196912 installment_duration: 0.10263654006109402 type: type base_fee: 7.143538047012306 payment_type: payment_type free_units: 7.058770351582356 allow_early_access: true currency: currency billing_duration: 0 trial_usage_limit: 3.0205796992916243 max_fee: 7.740351818741173 usage_unit_price: 3.0576100241049344 updatedOn: updatedOn retiredOn: retiredOn applicationPackageName: applicationPackageName targetAccounts: targetAccounts lastApprovedOn: lastApprovedOn lastPublishedOn: lastPublishedOn lastSubmittedOn: lastSubmittedOn rejectedReason: rejectedReason name: name trialDetails: trial_type: trial_type description: description trial_time_limit: 0.2025324113236393 comment: comment rejectedOn: rejectedOn replicationSchedule: replicationSchedule properties: additionalRegions: type: string applicationPackageName: type: string attachedShare: type: string autofulfillment: type: boolean comment: type: string createdOn: type: string customizedContactInfo: type: string defaultPricingPlan: $ref: '#/components/schemas/SnowflakeMarketplaceProductDefaultPricingPlan' detailedTargetAccounts: items: $ref: '#/components/schemas/SnowflakeMarketplaceProductDetailedTargetAccount' type: array distribution: type: string evaluationPlan: type: string firstPublishedOn: type: string flags: type: string fulfillmentType: type: string globalName: type: string isMountlessQueryable: type: boolean lastApprovedOn: type: string lastPublishedOn: type: string lastSubmittedOn: type: string listingType: type: string metadata: $ref: '#/components/schemas/SnowflakeMarketplaceProductMetadata' name: type: string pricingPlans: items: $ref: '#/components/schemas/SnowflakeMarketplaceProductPricingPlan' type: array private: type: boolean profileName: type: string publishOnApproval: type: boolean regions: type: string rejectedOn: type: string rejectedReason: type: string replicationSchedule: type: string retiredOn: type: string scheduledDropTime: type: string shareType: type: string state: type: string targetAccounts: type: string trialDetails: $ref: '#/components/schemas/SnowflakeMarketplaceTrialDetails' unpublishedByAdminReason: type: string updatedOn: type: string type: object SnowflakeMarketplaceProductDefaultPricingPlan: example: free_unit_kind: free_unit_kind trial_usage_unit: trial_usage_unit usage_unit_kind: usage_unit_kind is_auto_renewable: true installment_schedule: default_installment_amount: 6.519180951018382 overridden_installments: - installment_amount: 4.652396432933246 installment_number: 8.969578798196912 - installment_amount: 4.652396432933246 installment_number: 8.969578798196912 installment_duration: 0.10263654006109402 type: type base_fee: 7.143538047012306 payment_type: payment_type free_units: 7.058770351582356 allow_early_access: true currency: currency billing_duration: 0 trial_usage_limit: 3.0205796992916243 max_fee: 7.740351818741173 usage_unit_price: 3.0576100241049344 properties: allow_early_access: description: 'If true, consumers can access the listing before making a payment. You''ll need to remind them to pay.' type: boolean base_fee: type: number billing_duration: type: integer currency: type: string free_unit_kind: type: string free_units: type: number installment_schedule: $ref: '#/components/schemas/SnowflakeMarketplacePlanInstallmentSchedule' is_auto_renewable: description: IsAutoRenewable is true if the product is auto renewable. type: boolean max_fee: type: number payment_type: type: string trial_usage_limit: type: number trial_usage_unit: type: string type: type: string usage_unit_kind: type: string usage_unit_price: type: number type: object SnowflakeMarketplaceProductDetailedTargetAccount: example: company_name: company_name account_identifier: account_identifier properties: account_identifier: type: string company_name: type: string type: object SnowflakeMarketplaceProductMetadata: example: hasFreeSampleData: true areTermsProvidedOffline: true usage: '{}' description: description businessNeeds: '{}' share: share paidAttributes: '{}' title: title isWithStandardTerms: true properties: areTermsProvidedOffline: type: boolean businessNeeds: type: object description: type: string hasFreeSampleData: type: boolean isWithStandardTerms: type: boolean paidAttributes: type: object share: type: string title: type: string usage: type: object type: object SnowflakeMarketplaceProductPricingPlan: example: updated_on: updated_on billing_duration_months: '0' metadata: key: metadata visibility: visibility display_name: display_name usage_details: free_unit_kind: free_unit_kind free_units: 5.533258397034986 usage_unit_kind: usage_unit_kind max_fee: 3.2588565619047607 usage_unit_price: 4.078845849666752 base_fee: 7.04836565559697 contract_type: contract_type sales_motion: sales_motion pricing_model: pricing_model name: name comment: comment currency: currency state: state contract_duration_months: '0' properties: base_fee: type: number billing_duration_months: example: '0' type: string comment: type: string contract_duration_months: example: '0' type: string contract_type: description: PAY_AS_YOU_GO, LIMITED_TIME type: string currency: type: string display_name: type: string metadata: additionalProperties: type: string description: 'For pricing display purpose. eg: {"price":"10","button_text":"starter plan"}' type: object name: type: string pricing_model: description: 'pricing model: USAGE_BASED, FLAT_FEE' type: string sales_motion: description: SELF_SERVE, PROACTIVE type: string state: description: state of pricing plan type: string updated_on: type: string usage_details: $ref: '#/components/schemas/SnowflakeMarketplacePricingPlanUsageDetails' visibility: type: string type: object SnowflakeMarketplaceTrialDetails: example: trial_type: trial_type description: description trial_time_limit: 0.2025324113236393 properties: description: type: string trial_time_limit: type: number trial_type: type: string type: object StripeBalanceTransaction: properties: amount: description: Gross amount of this transaction (in cents (or local equivalent)). A positive value represents funds charged to another party, and a negative value represents funds sent to another party. type: integer available_on: description: The date that the transaction's net funds become available in the Stripe balance. type: integer chargeId: description: ID of the charge which the balance transaction comes from. type: string created: description: Time at which the object was created. Measured in seconds since the Unix epoch. type: integer description: description: An arbitrary string attached to the object. Often useful for displaying to users. type: string exchange_rate: description: If applicable, this transaction uses an exchange rate. If money converts from currency A to currency B, then the `amount` in currency A, multipled by the `exchange_rate`, equals the `amount` in currency B. For example, if you charge a customer 10.00 EUR, the PaymentIntent's `amount` is `1000` and `currency` is `eur`. If this converts to 12.34 USD in your Stripe account, the BalanceTransaction's `amount` is `1234`, its `currency` is `usd`, and the `exchange_rate` is `1.234`. type: number fee: description: Fees (in cents (or local equivalent)) paid for this transaction. Represented as a positive integer when assessed. type: integer fee_details: description: Detailed breakdown of fees (in cents (or local equivalent)) paid for this transaction. items: $ref: '#/components/schemas/StripeBalanceTransactionFeeDetail' type: array id: description: Unique identifier for the object. type: string net: description: Net impact to a Stripe balance (in cents (or local equivalent)). A positive value represents incrementing a Stripe balance, and a negative value decrementing a Stripe balance. You can calculate the net impact of a transaction on a balance by `amount` - `fee` type: integer status: description: The transaction's net funds status in the Stripe balance, which are either `available` or `pending`. type: string type: description: 'Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. Learn more about [balance transaction types and what they represent](https://stripe.com/docs/reports/balance-transaction-types). To classify transactions for accounting purposes, consider `reporting_category` instead.' type: string type: object StripeBalanceTransactionFeeDetail: properties: amount: description: Amount of the fee, in cents. type: integer application: description: ID of the Connect application that earned the fee. type: string description: description: An arbitrary string attached to the object. Often useful for displaying to users. type: string type: description: 'Type of the fee, one of: `application_fee`, `payment_method_passthrough_fee`, `stripe_fee` or `tax`.' type: string type: object StripeCustomer: properties: address: $ref: '#/components/schemas/StripeCustomerAddress' description: type: string email: type: string id: description: The customer ID on the stripe platform. type: string metadata: additionalProperties: type: string description: Set of key-value pairs that you can attach to store additional information about customer. type: object name: type: string phone: type: string type: object StripeCustomerAddress: properties: city: description: City, district, suburb, town, or village. type: string country: description: Two-letter country code (ISO 3166-1 alpha-2) type: string line1: description: Address line 1 (e.g., street, PO Box, or company name). type: string line2: description: Address line 2 (e.g., apartment, suite, unit, or building). type: string postal_code: description: ZIP or postal code. type: string state: description: State, county, province, or region. type: string type: object StripeDispute: example: paymentIntentId: paymentIntentId reason: reason amount: 6 is_charge_refundable: true livemode: true chargeId: chargeId created: 1 id: id status: status properties: amount: description: Disputed amount. Usually the amount of the charge, but it can differ (usually because of currency fluctuation or because only part of the order is disputed). type: integer chargeId: description: ID of the charge that's disputed. type: string created: description: Time at which the object was created. Measured in seconds since the Unix epoch. type: integer id: description: Unique identifier for the object. type: string is_charge_refundable: description: If true, it's still possible to refund the disputed payment. After the payment has been fully refunded, no further funds are withdrawn from your Stripe account as a result of this dispute. type: boolean livemode: description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean paymentIntentId: description: ID of the PaymentIntent that's disputed. type: string reason: description: Reason given by cardholder for dispute. Possible values are `bank_cannot_process`, `check_returned`, `credit_not_processed`, `customer_initiated`, `debit_not_authorized`, `duplicate`, `fraudulent`, `general`, `incorrect_account_details`, `insufficient_funds`, `product_not_received`, `product_unacceptable`, `subscription_canceled`, or `unrecognized`. Learn more about [dispute reasons](https://stripe.com/docs/disputes/categories). type: string status: description: Current status of dispute. Possible values are `warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `won`, or `lost`. type: string type: object StripeError: properties: code: type: string message: type: string param: type: string status: type: integer type: type: string type: object StripePaymentIntent: properties: id: description: Unique identifier for the object. type: string last_payment_error: allOf: - $ref: '#/components/schemas/StripeError' description: The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason. type: object livemode: description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean status: allOf: - $ref: '#/components/schemas/StripePaymentIntentStatus' description: Status of this PaymentIntent. Read more about each PaymentIntent [status](https://stripe.com/docs/payments/intents#intent-statuses). type: object type: object StripePaymentIntentStatus: enum: - requires_payment_method - requires_confirmation - requires_action - processing - requires_capture - canceled - succeeded type: string x-enum-varnames: - StripePaymentIntentStatus_RequiresPaymentMethod - StripePaymentIntentStatus_RequiresConfirmation - StripePaymentIntentStatus_RequiresAction - StripePaymentIntentStatus_Processing - StripePaymentIntentStatus_RequiresCapture - StripePaymentIntentStatus_Canceled - StripePaymentIntentStatus_Succeeded StripePaymentMethod: example: livemode: true bacs_debit: last4: last4 fingerprint: fingerprint sort_code: sort_code created: 1 us_bank_account: last4: last4 account_type: checking account_holder_type: individual bank_name: bank_name fingerprint: fingerprint routing_number: routing_number sepa_debit: branch_code: branch_code bank_code: bank_code country: country last4: last4 fingerprint: fingerprint id: id card: country: country last4: last4 funding: credit display_brand: display_brand fingerprint: fingerprint exp_month: 0 exp_year: 6 brand: amex object: object properties: bacs_debit: $ref: '#/components/schemas/StripePaymentMethodBACSDebit' card: $ref: '#/components/schemas/StripePaymentMethodCard' created: description: Time at which the object was created. Measured in seconds since the Unix epoch. type: integer id: description: Unique identifier for the payment method on stripe. type: string livemode: description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean object: description: String representing the object’s type. Always has the value `payment_method`. type: string sepa_debit: $ref: '#/components/schemas/StripePaymentMethodSEPADebit' us_bank_account: $ref: '#/components/schemas/StripePaymentMethodUSBankAccount' type: object StripePaymentMethodBACSDebit: example: last4: last4 fingerprint: fingerprint sort_code: sort_code properties: fingerprint: description: Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. type: string last4: description: Last four digits of the bank account number. type: string sort_code: description: Sort code of the bank account. (e.g., `10-20-30`) type: string type: object StripePaymentMethodCard: example: country: country last4: last4 funding: credit display_brand: display_brand fingerprint: fingerprint exp_month: 0 exp_year: 6 brand: amex properties: brand: description: Card brand. enum: - amex - diners - discover - eftpos_au - jcb - mastercard - unionpay - visa - unknown type: string country: description: Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. type: string display_brand: description: The brand to use when displaying the card, this accounts for customer's brand choice on dual-branded cards. Can be `american_express`, `cartes_bancaires`, `diners_club`, `discover`, `eftpos_australia`, `interac`, `jcb`, `mastercard`, `union_pay`, `visa`, or `other` and may contain more values in the future. type: string exp_month: description: Two-digit number representing the card's expiration month. type: integer exp_year: description: Four-digit number representing the card's expiration year. type: integer fingerprint: description: Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. type: string funding: description: Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. enum: - credit - debit - prepaid - unknown type: string last4: description: The last four digits of the card. type: string type: object StripePaymentMethodSEPADebit: example: branch_code: branch_code bank_code: bank_code country: country last4: last4 fingerprint: fingerprint properties: bank_code: description: Bank code of bank associated with the bank account. type: string branch_code: description: Branch code of bank associated with the bank account. type: string country: description: Two-letter ISO code representing the country the bank account is located in. type: string fingerprint: description: Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. type: string last4: description: Last four characters of the IBAN. type: string type: object StripePaymentMethodUSBankAccount: example: last4: last4 account_type: checking account_holder_type: individual bank_name: bank_name fingerprint: fingerprint routing_number: routing_number properties: account_holder_type: description: 'Account holder type: individual or company.' enum: - individual - company type: string account_type: description: 'Account type: checkings or savings. Defaults to checking if omitted.' enum: - checking - savings type: string bank_name: description: The name of the bank. type: string fingerprint: description: Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. type: string last4: description: Last four digits of the bank account number. type: string routing_number: description: Routing number of the bank account. type: string type: object StripeProduct: example: images: - images - images metadata: key: metadata livemode: true created: 6 active: true description: description url: url package_dimensions: '{}' statement_descriptor: statement_descriptor marketing_features: - name: name - name: name tax_code: '{}' shippable: true name: name id: id unit_label: unit_label updated: 4 object: object properties: active: description: Whether the product is currently available for purchase. type: boolean created: description: Time at which the object was created. Measured in seconds since the Unix epoch. type: integer description: description: The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes. type: string id: description: Unique identifier for the product in Stripe. type: string images: description: A list of up to 8 URLs of images for this product, meant to be displayable to the customer. items: type: string type: array livemode: description: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean marketing_features: description: A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table). items: $ref: '#/components/schemas/StripeProductMarketingFeature' type: array metadata: additionalProperties: type: string description: Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. type: object name: description: The product's name, meant to be displayable to the customer. type: string object: description: String representing the object's type. Always has the value `product`. type: string package_dimensions: allOf: - $ref: '#/components/schemas/StripeProductPackageDimensions' description: The dimensions of this product for shipping purposes. type: object shippable: description: Whether this product is shipped (i.e., physical goods). type: boolean statement_descriptor: description: 'Extra information about a product which will appear on your customer''s credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used.' type: string tax_code: description: A [tax code](https://stripe.com/docs/tax/tax-categories) ID. type: object unit_label: description: A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. type: string updated: description: Time at which the product was last updated. Measured in seconds since the Unix epoch. type: integer url: description: A URL of a publicly-accessible webpage for this product. type: string type: object StripeProductMarketingFeature: example: name: name properties: name: description: The marketing feature name. Up to 80 characters long. maxLength: 80 type: string type: object StripeProductPackageDimensions: properties: height: description: Height, in inches. type: number length: description: Length, in inches. type: number weight: description: Weight, in ounces. type: number width: description: Width, in inches. type: number type: object StripeRefund: properties: chargeId: description: ID of the charge that's refunded. type: string estinationDetails: allOf: - $ref: '#/components/schemas/StripeRefundDestinationDetails' description: Transaction-specific details for the refund. type: object failureBalanceTransactionId: description: After the refund fails, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction. type: string failureReason: description: 'Provides the reason for the refund failure. Possible values are: `lost_or_stolen_card`, `expired_or_canceled_card`, `charge_for_pending_refund_disputed`, `insufficient_funds`, `declined`, `merchant_request`, or `unknown`.' type: string id: type: string paymentIntentId: description: ID of the PaymentIntent that's refunded. type: string status: allOf: - $ref: '#/components/schemas/StripeRefundStatus' description: Status of the refund. This can be `pending`, `requires_action`, `succeeded`, `failed`, or `canceled`. Learn more about [failed refunds](https://stripe.com/docs/refunds#failed-refunds). type: object type: object StripeRefundDestinationDetails: properties: card: $ref: '#/components/schemas/StripeRefundDestinationDetailsCard' type: description: The type of transaction-specific details of the payment method used in the refund (e.g., `card`). An additional hash is included on `destination_details` with a name matching this value. It contains information specific to the refund transaction. type: string us_bank_transfer: $ref: '#/components/schemas/StripeRefundDestinationDetailsUSBankTransfer' type: object StripeRefundDestinationDetailsCard: properties: reference: description: Value of the reference number assigned to the refund. type: string reference_status: description: Status of the reference number on the refund. This can be `pending`, `available` or `unavailable`. enum: - pending - available - unavailable type: string reference_type: description: Type of the reference number assigned to the refund. type: string type: description: The type of refund. This can be `refund`, `reversal`, or `pending`. enum: - refund - reversal - pending type: string type: object StripeRefundDestinationDetailsUSBankTransfer: properties: reference: description: The reference assigned to the refund. type: string reference_status: description: Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. enum: - pending - available - unavailable type: string type: object StripeRefundStatus: enum: - pending - requires_action - succeeded - failed - canceled type: string x-enum-varnames: - StripeRefundStatus_Pending - StripeRefundStatus_RequiresAction - StripeRefundStatus_Succeeded - StripeRefundStatus_Failed - StripeRefundStatus_Canceled SupportTicket: example: creator: creator attachments: - date: date thumbnail_small: thumbnail_small thumbnail_medium: thumbnail_medium size: 0 thumbnail_large: thumbnail_large mimetype: mimetype id: id title: title url: url - date: date thumbnail_small: thumbnail_small thumbnail_medium: thumbnail_medium size: 0 thumbnail_large: thumbnail_large mimetype: mimetype id: id title: title url: url comments: - date: date comment_text: comment_text creator: '{}' comment: - image: thumbnail_small: thumbnail_small extension: extension thumbnail_medium: thumbnail_medium thumbnail_large: thumbnail_large name: name id: id title: title type: type url: url attachment: date: date thumbnail_small: thumbnail_small thumbnail_medium: thumbnail_medium size: 0 thumbnail_large: thumbnail_large mimetype: mimetype id: id title: title url: url text: text type: type frame: id: id url: url - image: thumbnail_small: thumbnail_small extension: extension thumbnail_medium: thumbnail_medium thumbnail_large: thumbnail_large name: name id: id title: title type: type url: url attachment: date: date thumbnail_small: thumbnail_small thumbnail_medium: thumbnail_medium size: 0 thumbnail_large: thumbnail_large mimetype: mimetype id: id title: title url: url text: text type: type frame: id: id url: url id: id - date: date comment_text: comment_text creator: '{}' comment: - image: thumbnail_small: thumbnail_small extension: extension thumbnail_medium: thumbnail_medium thumbnail_large: thumbnail_large name: name id: id title: title type: type url: url attachment: date: date thumbnail_small: thumbnail_small thumbnail_medium: thumbnail_medium size: 0 thumbnail_large: thumbnail_large mimetype: mimetype id: id title: title url: url text: text type: type frame: id: id url: url - image: thumbnail_small: thumbnail_small extension: extension thumbnail_medium: thumbnail_medium thumbnail_large: thumbnail_large name: name id: id title: title type: type url: url attachment: date: date thumbnail_small: thumbnail_small thumbnail_medium: thumbnail_medium size: 0 thumbnail_large: thumbnail_large mimetype: mimetype id: id title: title url: url text: text type: type frame: id: id url: url id: id creationTime: creationTime description: description watchers: - watchers - watchers dueTime: dueTime priority: LOW organizationId: organizationId closeTime: closeTime name: name id: id status: OPEN properties: attachments: items: $ref: '#/components/schemas/SupportTicketAttachment' type: array closeTime: type: string comments: items: $ref: '#/components/schemas/SupportTicketComment' type: array creationTime: type: string creator: type: string description: type: string dueTime: type: string id: type: string name: type: string organizationId: type: string priority: $ref: '#/components/schemas/SupportTicketPriority' status: $ref: '#/components/schemas/SupportTicketStatus' watchers: items: type: string type: array type: object SupportTicketAttachment: example: date: date thumbnail_small: thumbnail_small thumbnail_medium: thumbnail_medium size: 0 thumbnail_large: thumbnail_large mimetype: mimetype id: id title: title url: url properties: date: type: string id: type: string mimetype: type: string size: type: integer thumbnail_large: type: string thumbnail_medium: type: string thumbnail_small: type: string title: type: string url: type: string type: object SupportTicketComment: example: date: date comment_text: comment_text creator: '{}' comment: - image: thumbnail_small: thumbnail_small extension: extension thumbnail_medium: thumbnail_medium thumbnail_large: thumbnail_large name: name id: id title: title type: type url: url attachment: date: date thumbnail_small: thumbnail_small thumbnail_medium: thumbnail_medium size: 0 thumbnail_large: thumbnail_large mimetype: mimetype id: id title: title url: url text: text type: type frame: id: id url: url - image: thumbnail_small: thumbnail_small extension: extension thumbnail_medium: thumbnail_medium thumbnail_large: thumbnail_large name: name id: id title: title type: type url: url attachment: date: date thumbnail_small: thumbnail_small thumbnail_medium: thumbnail_medium size: 0 thumbnail_large: thumbnail_large mimetype: mimetype id: id title: title url: url text: text type: type frame: id: id url: url id: id properties: comment: items: $ref: '#/components/schemas/SupportTicketCommentDetail' type: array comment_text: description: When creating a new comment, only CommentText is required. type: string creator: allOf: - $ref: '#/components/schemas/SupportTicketUser' description: who created the comment type: object date: type: string id: type: string type: object SupportTicketCommentDetail: example: image: thumbnail_small: thumbnail_small extension: extension thumbnail_medium: thumbnail_medium thumbnail_large: thumbnail_large name: name id: id title: title type: type url: url attachment: date: date thumbnail_small: thumbnail_small thumbnail_medium: thumbnail_medium size: 0 thumbnail_large: thumbnail_large mimetype: mimetype id: id title: title url: url text: text type: type frame: id: id url: url properties: attachment: $ref: '#/components/schemas/SupportTicketAttachment' frame: $ref: '#/components/schemas/SupportTicketFrame' image: $ref: '#/components/schemas/SupportTicketImage' text: type: string type: type: string type: object SupportTicketFrame: example: id: id url: url properties: id: type: string url: type: string type: object SupportTicketImage: example: thumbnail_small: thumbnail_small extension: extension thumbnail_medium: thumbnail_medium thumbnail_large: thumbnail_large name: name id: id title: title type: type url: url properties: extension: type: string id: type: string name: type: string thumbnail_large: type: string thumbnail_medium: type: string thumbnail_small: type: string title: type: string type: type: string url: type: string type: object SupportTicketPriority: enum: - LOW - NORMAL - HIGH - URGENT type: string x-enum-varnames: - SupportTicketPriority_LOW - SupportTicketPriority_NORMAL - SupportTicketPriority_HIGH - SupportTicketPriority_URGENT SupportTicketStatus: enum: - OPEN - IN PROGRESS - IN REVIEW - BLOCKED - CLOSED - ARCHIVED - DELETED type: string x-enum-varnames: - SupportTicketStatus_OPEN - SupportTicketStatus_IN_PROGRESS - SupportTicketStatus_IN_REVIEW - SupportTicketStatus_BLOCKED - SupportTicketStatus_CLOSED - SupportTicketStatus_ARCHIVED - SupportTicketStatus_DELETED SupportTicketUser: properties: email: type: string id: description: The Suger user ID. type: string isSugerEmployee: description: Whether the user is a Suger employee. type: boolean profilePicture: type: string username: type: string type: object TimeUnit: enum: - DAY - MONTH - YEAR type: string x-enum-varnames: - TimeUnit_DAY - TimeUnit_MONTH - TimeUnit_YEAR TrackEvent: example: contactId: contactId action: OPEN_EMAIL timestamp: 2000-01-23 04:56:07+00:00 properties: action: $ref: '#/components/schemas/TrackEventActionType' contactId: description: The ID of the contact who triggered the track event if applicable. type: string timestamp: description: timestamp of the track event happened. format: date-time type: string type: object TrackEventActionType: enum: - OPEN_EMAIL type: string x-enum-varnames: - TrackEventActionType_OPEN_EMAIL TrialConfig: properties: trialPeriod: type: integer trialPeriodUnit: $ref: '#/components/schemas/TimeUnit' type: object UniqueCountAggregationResult: properties: newItems: additionalProperties: true description: Unique property values of current hour that are new of today. Leave the value as interface{} to save space. type: object type: object UpdateBillableMetricParams: example: name: name description: description status: ACTIVE properties: description: type: string name: type: string status: $ref: '#/components/schemas/BillableMetricStatus' type: object UpdateBuyerParams: example: paymentConfig: '{}' orbCustomerId: orbCustomerId companyInfo: '{}' customerId: customerId name: name description: description lagoCustomerId: lagoCustomerId metronomeCustomerId: metronomeCustomerId stripeCustomerId: stripeCustomerId properties: companyInfo: allOf: - $ref: '#/components/schemas/CompanyInfo' description: Optional. CompanyInfo of the buyer. type: object customerId: description: 'The customer ID to recognize the cloud marketplace buyer in your internal system. This may be used for uploading CSV files for Batch Metering Usage' type: string description: description: The description of the buyer. If not provided, the description will not be updated. type: string lagoCustomerId: description: The Lago Customer ID of the buyer. If not provided, the Lago Customer ID will not be updated. type: string metronomeCustomerId: description: The Metronome Customer ID of the buyer. If not provided, the Metronome Customer ID will not be updated. type: string name: description: The name of the buyer. If not provided, the name will not be updated. type: string orbCustomerId: description: The Orb Customer ID of the buyer. If not provided, the Orb Customer ID will not be updated. type: string paymentConfig: allOf: - $ref: '#/components/schemas/PaymentConfig' description: Optional. PaymentConfig of the buyer. The currency can't be updated. type: object stripeCustomerId: description: The Stripe Customer ID of the buyer. If not provided, the Stripe Customer ID will not be updated. type: string type: object UpdateEntitlementPriceModelParams: example: commits: - types: - types - types quantity: 4 length: 9 description: description type: '{}' maximumUsers: 361608 rate: 7.386281948385884 isUserCreated: true minimumUsers: 202713 name: name term: term category: category termEndTime: termEndTime key: key timeUnit: '{}' - types: - types - types quantity: 4 length: 9 description: description type: '{}' maximumUsers: 361608 rate: 7.386281948385884 isUserCreated: true minimumUsers: 202713 name: name term: term category: category termEndTime: termEndTime key: key timeUnit: '{}' applyTime: applyTime billableDimensions: - priceModelTiered: '{}' priceModelTieredPercentage: '{}' priceModelMatrix: '{}' minimumCommit: 5.962133916683182 length: 1 priceModelBulk: '{}' description: description discount: '{}' minimumCommitScope: '{}' minimumCommitProrata: true billableMetricId: billableMetricId priceModelPercentage: '{}' name: name priceModelBasic: '{}' category: '{}' priceModelVolume: '{}' timeUnit: '{}' - priceModelTiered: '{}' priceModelTieredPercentage: '{}' priceModelMatrix: '{}' minimumCommit: 5.962133916683182 length: 1 priceModelBulk: '{}' description: description discount: '{}' minimumCommitScope: '{}' minimumCommitProrata: true billableMetricId: billableMetricId priceModelPercentage: '{}' name: name priceModelBasic: '{}' category: '{}' priceModelVolume: '{}' timeUnit: '{}' properties: applyTime: type: string billableDimensions: items: $ref: '#/components/schemas/BillableDimension' type: array commits: items: $ref: '#/components/schemas/CommitDimension' type: array type: object UpdateInvoiceInfoRequest: example: dueDate: dueDate discountAmount: 0.8008281904610115 memo: memo discountType: '{}' properties: discountAmount: type: number discountType: allOf: - $ref: '#/components/schemas/BillingDiscountType' description: The overall discount of the invoice. type: object dueDate: type: string memo: type: string type: object UpdateProductParams: example: organizationID: organizationID fulfillmentUrl: fulfillmentUrl id: id properties: fulfillmentUrl: type: string id: type: string organizationID: type: string required: - fulfillmentUrl - id - organizationID type: object UpdateSupportTicketRequest: example: watchers: - watchers - watchers priority: LOW properties: priority: $ref: '#/components/schemas/SupportTicketPriority' watchers: items: type: string type: array required: - priority - watchers type: object UsageCount: properties: creditCount: description: The count of this dimension usage records that are handled as credit. type: number includedCount: description: The count of this dimension usage records that are handled as included in IncludedBaseQuantity type: number reportedCount: description: The count of this dimension usage records that are reported to cloud vendors. type: number type: object UsageMeteringConfigInfo: example: partnerUsageMeteringConfigs: - enableCommitWithAdditionalUsageAtListPrice: true enableDimensionMapping: true dimensionMapping: key: convertionMultiplier: 0.8008281904610115 dimensionKey: dimensionKey mappingMode: '{}' partner: '{}' enableBillableDimension: true enableCommitWithAdditionalUsageMetering: true dimensionMappingV2: key: - convertionMultiplier: 0.8008281904610115 dimensionKey: dimensionKey mappingMode: '{}' - convertionMultiplier: 0.8008281904610115 dimensionKey: dimensionKey mappingMode: '{}' - enableCommitWithAdditionalUsageAtListPrice: true enableDimensionMapping: true dimensionMapping: key: convertionMultiplier: 0.8008281904610115 dimensionKey: dimensionKey mappingMode: '{}' partner: '{}' enableBillableDimension: true enableCommitWithAdditionalUsageMetering: true dimensionMappingV2: key: - convertionMultiplier: 0.8008281904610115 dimensionKey: dimensionKey mappingMode: '{}' - convertionMultiplier: 0.8008281904610115 dimensionKey: dimensionKey mappingMode: '{}' properties: partnerUsageMeteringConfigs: description: The usage metering configuration for each Partner, such as AWS, AZURE & GCP. items: $ref: '#/components/schemas/PartnerUsageMeteringConfig' type: array type: object UsageMeteringDailyRecord: example: date: 2000-01-23 04:56:07+00:00 amount: 6.027456183070403 quantity: 1.4658129805029452 partner: '{}' entitlementID: entitlementID groupBysExpression: groupBysExpression key: key properties: amount: type: number date: format: date-time type: string entitlementID: description: The Entitlement ID of the usage metering daily record. type: string groupBysExpression: description: 'The group bys expression of the usage metering. When the same usage metering key may have multiple expressions of group bys to aggregate the usage.' type: string key: description: The dimension key of the usage metering. type: string partner: allOf: - $ref: '#/components/schemas/Partner' description: The partner where this usage metering daily record is from. Such as AWS, AZURE or GCP. type: object quantity: type: number type: object UsageMeteringDimensionMappingMode: enum: - '' - QUANTITY - AMOUNT type: string x-enum-varnames: - UsageMeteringDimensionMappingMode_UNKNOWN - UsageMeteringDimensionMappingMode_QUANTITY - UsageMeteringDimensionMappingMode_AMOUNT UsageMeteringDimensionMappingValue: example: convertionMultiplier: 0.8008281904610115 dimensionKey: dimensionKey mappingMode: '{}' properties: convertionMultiplier: description: 'The convertion multiplier when mapping from the source dimension key to the destination dimensionKey by quantity mode. Not required if the mapping mode is AMOUNT.' type: number dimensionKey: description: The destination dimension key of the usage metering mapping. type: string mappingMode: allOf: - $ref: '#/components/schemas/UsageMeteringDimensionMappingMode' description: The conversion mode of UsageMeteringDimensionMapping. The default is QUANTITY if not available. type: object type: object UsageRecordGroupSource: enum: - '' - API - INTERNAL - LAGO - METRONOME - ORB - STRIPE type: string x-enum-varnames: - UsageRecordGroupSourceUNKNOWN - UsageRecordGroupSourceAPI - UsageRecordGroupSourceINTERNAL - UsageRecordGroupSourceLAGO - UsageRecordGroupSourceMETRONOME - UsageRecordGroupSourceORB - UsageRecordGroupSourceSTRIPE UsageRecordReportStatus: enum: - '' - SUCCESS - FAILED - CREATED - INVOICED - DELETED - CANCELED type: string x-enum-varnames: - UsageRecordReportStatus_UNKNOWN - UsageRecordReportStatus_SUCCESS - UsageRecordReportStatus_FAILED - UsageRecordReportStatus_CREATED - UsageRecordReportStatus_INVOICED - UsageRecordReportStatus_DELETED - UsageRecordReportStatus_CANCELED ValueType: enum: - '' - VALUE_TYPE_UNSPECIFIED - BOOL - INT64 - DOUBLE - STRING - DISTRIBUTION - MONEY type: string x-enum-varnames: - ValueType_UNKNOWN - ValueType_UNSPECIFIED - ValueType_BOOL - ValueType_INT64 - ValueType_DOUBLE - ValueType_STRING - ValueType_DISTRIBUTION - ValueType_MONEY WorkloadEntitlement: example: entitlementTermID: entitlementTermID creationTime: 2000-01-23 04:56:07+00:00 productID: productID externalBuyerID: externalBuyerID externalID: externalID buyerID: buyerID type: type organizationID: organizationID metaInfo: cppoOfferId: cppoOfferId enableTestUsageMetering: true replacedOfferResourceName: replacedOfferResourceName renewalOfferType: '{}' isAgreementBasedOffer: true isRenewalOffer: true cppoInOfferId: cppoInOfferId aceApnCrmUniqueIdentifier: aceApnCrmUniqueIdentifier testUsageMeteringEndTime: 2000-01-23 04:56:07+00:00 entitlementCancellationSchedule: '{}' isGrossRevenueFullSync: true offerAcceptDate: 2000-01-23 04:56:07+00:00 salesforceOpportunityId: salesforceOpportunityId hubspotDealId: hubspotDealId prettifiedErrorMessages: - prettifiedErrorMessages - prettifiedErrorMessages replacedOfferEndTime: 2000-01-23 04:56:07+00:00 lastModifiedBy: '{}' customMetaInfo: key: customMetaInfo isReplacementOffer: true buyerIds: - buyerIds - buyerIds cppoOutOfferId: cppoOutOfferId errorMessages: - errorMessages - errorMessages baseAgreementId: baseAgreementId internalNote: internalNote salesforceEntitlementURL: salesforceEntitlementURL awsSaasProductDimensions: - Types: - Types - Types Description: Description Length: 2 Rate: 6.778324963048013 TimeUnit: DAY Unit: Unit Key: Key Name: Name - Types: - Types - Types Description: Description Length: 2 Rate: 6.778324963048013 TimeUnit: DAY Unit: Unit Key: Key Name: Name contacts: - name: name company: company email: email - name: name company: company email: email notifications: - eventID: eventID customFields: key: '' entityType: '' contactEmails: - contactEmails - contactEmails entityID: entityID message: message priority: '{}' title: title contactIds: - contactIds - contactIds organizationID: organizationID ccContactIds: - ccContactIds - ccContactIds channels: - EMAIL - EMAIL isActionItem: true partner: '{}' createdBy: '{}' entityStatus: entityStatus entityName: entityName eventStatus: '{}' action: '' requireAudit: true trackEvents: - contactId: contactId action: OPEN_EMAIL timestamp: 2000-01-23 04:56:07+00:00 - contactId: contactId action: OPEN_EMAIL timestamp: 2000-01-23 04:56:07+00:00 info: '{}' lastUpdateTime: 2000-01-23 04:56:07+00:00 timestamp: 2000-01-23 04:56:07+00:00 - eventID: eventID customFields: key: '' entityType: '' contactEmails: - contactEmails - contactEmails entityID: entityID message: message priority: '{}' title: title contactIds: - contactIds - contactIds organizationID: organizationID ccContactIds: - ccContactIds - ccContactIds channels: - EMAIL - EMAIL isActionItem: true partner: '{}' createdBy: '{}' entityStatus: entityStatus entityName: entityName eventStatus: '{}' action: '' requireAudit: true trackEvents: - contactId: contactId action: OPEN_EMAIL timestamp: 2000-01-23 04:56:07+00:00 - contactId: contactId action: OPEN_EMAIL timestamp: 2000-01-23 04:56:07+00:00 info: '{}' lastUpdateTime: 2000-01-23 04:56:07+00:00 timestamp: 2000-01-23 04:56:07+00:00 updateMessage: updateMessage partner: '' service: DEFAULT name: name offerID: offerID startTime: 2000-01-23 04:56:07+00:00 endTime: 2000-01-23 04:56:07+00:00 id: id partnerID: partnerID externalProductID: externalProductID info: alibabaOrders: - PaidOn: 1 CouponPrice: 2.027123023002322 PeriodType: PeriodType OriginalPrice: 1.2315135367772556 PayStatus: PayStatus ProductName: ProductName RequestId: RequestId ProductCode: ProductCode SupplierCompanyName: SupplierCompanyName Quantity: 6 OrderId: 7 SupplierTelephones: Telephone: - Telephone - Telephone Components: key: '' OrderStatus: OrderStatus OrderType: OrderType TotalPrice: 7.457744773683766 ProductSkuCode: ProductSkuCode CreatedOn: 4 PaymentPrice: 1.4894159098541704 InstanceIds: InstanceId: - InstanceId - InstanceId AccountQuantity: 9 AliUid: 3 - PaidOn: 1 CouponPrice: 2.027123023002322 PeriodType: PeriodType OriginalPrice: 1.2315135367772556 PayStatus: PayStatus ProductName: ProductName RequestId: RequestId ProductCode: ProductCode SupplierCompanyName: SupplierCompanyName Quantity: 6 OrderId: 7 SupplierTelephones: Telephone: - Telephone - Telephone Components: key: '' OrderStatus: OrderStatus OrderType: OrderType TotalPrice: 7.457744773683766 ProductSkuCode: ProductSkuCode CreatedOn: 4 PaymentPrice: 1.4894159098541704 InstanceIds: InstanceId: - InstanceId - InstanceId AccountQuantity: 9 AliUid: 3 invoicedAmount: 6.438423552598547 addons: - amount: 0.8008281904610115 name: name description: description chargeOn: 2000-01-23 04:56:07+00:00 id: id - amount: 0.8008281904610115 name: name description: description chargeOn: 2000-01-23 04:56:07+00:00 id: id trialConfig: '{}' azureSubscriptions: - fulfillmentId: fulfillmentId quantity: 1 allowedCustomerOperations: - Read - Read created: 2000-01-23 04:56:07+00:00 purchaser: firstName: firstName lastName: lastName licenseType: licenseType puid: puid customerId: customerId tenantId: tenantId billingAccountId: billingAccountId emailId: emailId objectId: objectId isFreeTrial: true sessionId: sessionId saasSubscriptionStatus: NotStarted publisherId: publisherId beneficiary: firstName: firstName lastName: lastName licenseType: licenseType puid: puid customerId: customerId tenantId: tenantId billingAccountId: billingAccountId emailId: emailId objectId: objectId isTest: true name: name autoRenew: true offerId: offerId planId: planId storeFront: storeFront term: endDate: 2000-01-23 04:56:07+00:00 chargeDuration: chargeDuration startDate: 2000-01-23 04:56:07+00:00 termUnit: termUnit id: id lastModified: lastModified sandboxType: None sessionMode: None - fulfillmentId: fulfillmentId quantity: 1 allowedCustomerOperations: - Read - Read created: 2000-01-23 04:56:07+00:00 purchaser: firstName: firstName lastName: lastName licenseType: licenseType puid: puid customerId: customerId tenantId: tenantId billingAccountId: billingAccountId emailId: emailId objectId: objectId isFreeTrial: true sessionId: sessionId saasSubscriptionStatus: NotStarted publisherId: publisherId beneficiary: firstName: firstName lastName: lastName licenseType: licenseType puid: puid customerId: customerId tenantId: tenantId billingAccountId: billingAccountId emailId: emailId objectId: objectId isTest: true name: name autoRenew: true offerId: offerId planId: planId storeFront: storeFront term: endDate: 2000-01-23 04:56:07+00:00 chargeDuration: chargeDuration startDate: 2000-01-23 04:56:07+00:00 termUnit: termUnit id: id lastModified: lastModified sandboxType: None sessionMode: None awsEntitlements: - productCode: productCode customerIdentifier: customerIdentifier dimension: dimension value: '{}' expirationDate: expirationDate - productCode: productCode customerIdentifier: customerIdentifier dimension: dimension value: '{}' expirationDate: expirationDate gcpEntitlements: - newPendingOffer: newPendingOffer offerEffectiveTime: 2000-01-23 04:56:07+00:00 newPlan: newPlan offer: offer inputProperties: - 6 - 6 provider: provider offerEndTime: 2000-01-23 04:56:07+00:00 offerDuration: offerDuration consumers: - project: project - project: project newOfferEndTime: newOfferEndTime subscriptionEndTime: 2000-01-23 04:56:07+00:00 id: id state: '{}' usageReportingId: usageReportingId plan: plan messageToUser: messageToUser product: product updateTime: 2000-01-23 04:56:07+00:00 newOfferDuration: newOfferDuration quoteExternalName: quoteExternalName createTime: 2000-01-23 04:56:07+00:00 newPendingPlan: newPendingPlan name: name newPendingOfferDuration: newPendingOfferDuration account: account productExternalName: productExternalName newOfferStartTime: newOfferStartTime - newPendingOffer: newPendingOffer offerEffectiveTime: 2000-01-23 04:56:07+00:00 newPlan: newPlan offer: offer inputProperties: - 6 - 6 provider: provider offerEndTime: 2000-01-23 04:56:07+00:00 offerDuration: offerDuration consumers: - project: project - project: project newOfferEndTime: newOfferEndTime subscriptionEndTime: 2000-01-23 04:56:07+00:00 id: id state: '{}' usageReportingId: usageReportingId plan: plan messageToUser: messageToUser product: product updateTime: 2000-01-23 04:56:07+00:00 newOfferDuration: newOfferDuration quoteExternalName: quoteExternalName createTime: 2000-01-23 04:56:07+00:00 newPendingPlan: newPendingPlan name: name newPendingOfferDuration: newPendingOfferDuration account: account productExternalName: productExternalName newOfferStartTime: newOfferStartTime paymentInstallments: - discountPercentage: 3.5571952270680973 amount: 9.018348186070783 originalAmount: 6.965117697638846 chargeOn: 2000-01-23 04:56:07+00:00 chargeOnStr: chargeOnStr credit: 6.438423552598547 - discountPercentage: 3.5571952270680973 amount: 9.018348186070783 originalAmount: 6.965117697638846 chargeOn: 2000-01-23 04:56:07+00:00 chargeOnStr: chargeOnStr credit: 6.438423552598547 billableDimensions: - priceModelTiered: '{}' priceModelTieredPercentage: '{}' priceModelMatrix: '{}' minimumCommit: 5.962133916683182 length: 1 priceModelBulk: '{}' description: description discount: '{}' minimumCommitScope: '{}' minimumCommitProrata: true billableMetricId: billableMetricId priceModelPercentage: '{}' name: name priceModelBasic: '{}' category: '{}' priceModelVolume: '{}' timeUnit: '{}' - priceModelTiered: '{}' priceModelTieredPercentage: '{}' priceModelMatrix: '{}' minimumCommit: 5.962133916683182 length: 1 priceModelBulk: '{}' description: description discount: '{}' minimumCommitScope: '{}' minimumCommitProrata: true billableMetricId: billableMetricId priceModelPercentage: '{}' name: name priceModelBasic: '{}' category: '{}' priceModelVolume: '{}' timeUnit: '{}' eulaUrl: eulaUrl billingIntervalInMonths: 4 refundCancellationPolicy: refundCancellationPolicy paymentSchedule: '{}' autoRenew: true currency: currency alibabaEntitlements: - Status: Status ProductName: ProductName EndOn: 5 InstanceId: 2 ProductCode: ProductCode Modules: Module: - Id: Id Properties: Property: - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark DisplayUnit: DisplayUnit Key: Key Name: Name ShowType: ShowType - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark DisplayUnit: DisplayUnit Key: Key Name: Name ShowType: ShowType Code: Code Name: Name - Id: Id Properties: Property: - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark DisplayUnit: DisplayUnit Key: Key Name: Name ShowType: ShowType - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark DisplayUnit: DisplayUnit Key: Key Name: Name ShowType: ShowType Code: Code Name: Name RelationalData: ServiceStatus: ServiceStatus AppJson: AppJson ProductType: ProductType OrderId: 7 Constraints: Constraints AutoRenewal: AutoRenewal ExtendJson: ExtendJson ComponentJson: ComponentJson IsTrial: true SupplierName: SupplierName ProductSkuCode: ProductSkuCode CreatedOn: 5 HostJson: HostJson BeganOn: 1 - Status: Status ProductName: ProductName EndOn: 5 InstanceId: 2 ProductCode: ProductCode Modules: Module: - Id: Id Properties: Property: - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark DisplayUnit: DisplayUnit Key: Key Name: Name ShowType: ShowType - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark DisplayUnit: DisplayUnit Key: Key Name: Name ShowType: ShowType Code: Code Name: Name - Id: Id Properties: Property: - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark DisplayUnit: DisplayUnit Key: Key Name: Name ShowType: ShowType - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark DisplayUnit: DisplayUnit Key: Key Name: Name ShowType: ShowType Code: Code Name: Name RelationalData: ServiceStatus: ServiceStatus AppJson: AppJson ProductType: ProductType OrderId: 7 Constraints: Constraints AutoRenewal: AutoRenewal ExtendJson: ExtendJson ComponentJson: ComponentJson IsTrial: true SupplierName: SupplierName ProductSkuCode: ProductSkuCode CreatedOn: 5 HostJson: HostJson BeganOn: 1 disbursedAmount: 9.369310271410669 netTermsInDays: 3 dimensionsOversized: true eulaType: '' gracePeriodInDays: 8 grossAmount: 9.018348186070783 gcpPlans: - priceInfo: usageFees: - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 subscriptionPlans: - period: period price: nanos: 1 units: units currencyCode: currencyCode - period: period price: nanos: 1 units: units currencyCode: currencyCode description: description priceModel: FREE purchaseMode: PURCHASE_MODE_PRIVATE name: name title: title featureValues: - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription - priceInfo: usageFees: - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 subscriptionPlans: - period: period price: nanos: 1 units: units currencyCode: currencyCode - period: period price: nanos: 1 units: units currencyCode: currencyCode description: description priceModel: FREE purchaseMode: PURCHASE_MODE_PRIVATE name: name title: title featureValues: - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription collectableAmount: 5.025004791520295 buyerManagementURL: buyerManagementURL alertDaysBeforeEnd: 6 sellerNotes: sellerNotes awsAgreement: '{}' billingCycle: '{}' commits: - types: - types - types quantity: 4 length: 9 description: description type: '{}' maximumUsers: 361608 rate: 7.386281948385884 isUserCreated: true minimumUsers: 202713 name: name term: term category: category termEndTime: termEndTime key: key timeUnit: '{}' - types: - types - types quantity: 4 length: 9 description: description type: '{}' maximumUsers: 361608 rate: 7.386281948385884 isUserCreated: true minimumUsers: 202713 name: name term: term category: category termEndTime: termEndTime key: key timeUnit: '{}' isMeteringOverageCommit: true awsChannelPartner: '{}' commitAmount: 9.965781217890562 dimensions: - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 types: - types - types description: description planName: planName usageCount: '{}' rate: 6.84685269835264 includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly valueType: '{}' name: name planId: planId category: category key: key skuId: skuId - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 types: - types - types description: description planName: planName usageCount: '{}' rate: 6.84685269835264 includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly valueType: '{}' name: name planId: planId category: category key: key skuId: skuId snowflakeOffer: '{}' spaUrl: spaUrl lastUpdateTime: 2000-01-23 04:56:07+00:00 status: '' properties: buyerID: type: string creationTime: format: date-time type: string endTime: description: nullable format: date-time type: string entitlementTermID: type: string externalBuyerID: type: string externalID: type: string externalProductID: type: string id: type: string info: $ref: '#/components/schemas/EntitlementInfo' lastUpdateTime: format: date-time type: string metaInfo: $ref: '#/components/schemas/WorkloadMetaInfo' name: type: string offerID: type: string organizationID: type: string partner: $ref: '#/components/schemas/Partner' partnerID: type: string productID: type: string service: $ref: '#/components/schemas/PartnerService' startTime: format: date-time type: string status: $ref: '#/components/schemas/EntitlementStatus' type: type: string type: object WorkloadEntitlementTerm: example: externalEntitlementID: externalEntitlementID creationTime: creationTime productID: productID entitlementID: entitlementID usedCommitAmount: 5.637376656633329 buyerID: buyerID usedCreditAmount: 2.3021358869347655 organizationID: organizationID partner: '' service: DEFAULT offerID: offerID reportedAmount: 5.962133916683182 startTime: 2000-01-23 04:56:07+00:00 endTime: 2000-01-23 04:56:07+00:00 id: id creditAmount: 6.027456183070403 commitAmount: 0.8008281904610115 entitlementInfo: alibabaOrders: - PaidOn: 1 CouponPrice: 2.027123023002322 PeriodType: PeriodType OriginalPrice: 1.2315135367772556 PayStatus: PayStatus ProductName: ProductName RequestId: RequestId ProductCode: ProductCode SupplierCompanyName: SupplierCompanyName Quantity: 6 OrderId: 7 SupplierTelephones: Telephone: - Telephone - Telephone Components: key: '' OrderStatus: OrderStatus OrderType: OrderType TotalPrice: 7.457744773683766 ProductSkuCode: ProductSkuCode CreatedOn: 4 PaymentPrice: 1.4894159098541704 InstanceIds: InstanceId: - InstanceId - InstanceId AccountQuantity: 9 AliUid: 3 - PaidOn: 1 CouponPrice: 2.027123023002322 PeriodType: PeriodType OriginalPrice: 1.2315135367772556 PayStatus: PayStatus ProductName: ProductName RequestId: RequestId ProductCode: ProductCode SupplierCompanyName: SupplierCompanyName Quantity: 6 OrderId: 7 SupplierTelephones: Telephone: - Telephone - Telephone Components: key: '' OrderStatus: OrderStatus OrderType: OrderType TotalPrice: 7.457744773683766 ProductSkuCode: ProductSkuCode CreatedOn: 4 PaymentPrice: 1.4894159098541704 InstanceIds: InstanceId: - InstanceId - InstanceId AccountQuantity: 9 AliUid: 3 invoicedAmount: 6.438423552598547 addons: - amount: 0.8008281904610115 name: name description: description chargeOn: 2000-01-23 04:56:07+00:00 id: id - amount: 0.8008281904610115 name: name description: description chargeOn: 2000-01-23 04:56:07+00:00 id: id trialConfig: '{}' azureSubscriptions: - fulfillmentId: fulfillmentId quantity: 1 allowedCustomerOperations: - Read - Read created: 2000-01-23 04:56:07+00:00 purchaser: firstName: firstName lastName: lastName licenseType: licenseType puid: puid customerId: customerId tenantId: tenantId billingAccountId: billingAccountId emailId: emailId objectId: objectId isFreeTrial: true sessionId: sessionId saasSubscriptionStatus: NotStarted publisherId: publisherId beneficiary: firstName: firstName lastName: lastName licenseType: licenseType puid: puid customerId: customerId tenantId: tenantId billingAccountId: billingAccountId emailId: emailId objectId: objectId isTest: true name: name autoRenew: true offerId: offerId planId: planId storeFront: storeFront term: endDate: 2000-01-23 04:56:07+00:00 chargeDuration: chargeDuration startDate: 2000-01-23 04:56:07+00:00 termUnit: termUnit id: id lastModified: lastModified sandboxType: None sessionMode: None - fulfillmentId: fulfillmentId quantity: 1 allowedCustomerOperations: - Read - Read created: 2000-01-23 04:56:07+00:00 purchaser: firstName: firstName lastName: lastName licenseType: licenseType puid: puid customerId: customerId tenantId: tenantId billingAccountId: billingAccountId emailId: emailId objectId: objectId isFreeTrial: true sessionId: sessionId saasSubscriptionStatus: NotStarted publisherId: publisherId beneficiary: firstName: firstName lastName: lastName licenseType: licenseType puid: puid customerId: customerId tenantId: tenantId billingAccountId: billingAccountId emailId: emailId objectId: objectId isTest: true name: name autoRenew: true offerId: offerId planId: planId storeFront: storeFront term: endDate: 2000-01-23 04:56:07+00:00 chargeDuration: chargeDuration startDate: 2000-01-23 04:56:07+00:00 termUnit: termUnit id: id lastModified: lastModified sandboxType: None sessionMode: None awsEntitlements: - productCode: productCode customerIdentifier: customerIdentifier dimension: dimension value: '{}' expirationDate: expirationDate - productCode: productCode customerIdentifier: customerIdentifier dimension: dimension value: '{}' expirationDate: expirationDate gcpEntitlements: - newPendingOffer: newPendingOffer offerEffectiveTime: 2000-01-23 04:56:07+00:00 newPlan: newPlan offer: offer inputProperties: - 6 - 6 provider: provider offerEndTime: 2000-01-23 04:56:07+00:00 offerDuration: offerDuration consumers: - project: project - project: project newOfferEndTime: newOfferEndTime subscriptionEndTime: 2000-01-23 04:56:07+00:00 id: id state: '{}' usageReportingId: usageReportingId plan: plan messageToUser: messageToUser product: product updateTime: 2000-01-23 04:56:07+00:00 newOfferDuration: newOfferDuration quoteExternalName: quoteExternalName createTime: 2000-01-23 04:56:07+00:00 newPendingPlan: newPendingPlan name: name newPendingOfferDuration: newPendingOfferDuration account: account productExternalName: productExternalName newOfferStartTime: newOfferStartTime - newPendingOffer: newPendingOffer offerEffectiveTime: 2000-01-23 04:56:07+00:00 newPlan: newPlan offer: offer inputProperties: - 6 - 6 provider: provider offerEndTime: 2000-01-23 04:56:07+00:00 offerDuration: offerDuration consumers: - project: project - project: project newOfferEndTime: newOfferEndTime subscriptionEndTime: 2000-01-23 04:56:07+00:00 id: id state: '{}' usageReportingId: usageReportingId plan: plan messageToUser: messageToUser product: product updateTime: 2000-01-23 04:56:07+00:00 newOfferDuration: newOfferDuration quoteExternalName: quoteExternalName createTime: 2000-01-23 04:56:07+00:00 newPendingPlan: newPendingPlan name: name newPendingOfferDuration: newPendingOfferDuration account: account productExternalName: productExternalName newOfferStartTime: newOfferStartTime paymentInstallments: - discountPercentage: 3.5571952270680973 amount: 9.018348186070783 originalAmount: 6.965117697638846 chargeOn: 2000-01-23 04:56:07+00:00 chargeOnStr: chargeOnStr credit: 6.438423552598547 - discountPercentage: 3.5571952270680973 amount: 9.018348186070783 originalAmount: 6.965117697638846 chargeOn: 2000-01-23 04:56:07+00:00 chargeOnStr: chargeOnStr credit: 6.438423552598547 billableDimensions: - priceModelTiered: '{}' priceModelTieredPercentage: '{}' priceModelMatrix: '{}' minimumCommit: 5.962133916683182 length: 1 priceModelBulk: '{}' description: description discount: '{}' minimumCommitScope: '{}' minimumCommitProrata: true billableMetricId: billableMetricId priceModelPercentage: '{}' name: name priceModelBasic: '{}' category: '{}' priceModelVolume: '{}' timeUnit: '{}' - priceModelTiered: '{}' priceModelTieredPercentage: '{}' priceModelMatrix: '{}' minimumCommit: 5.962133916683182 length: 1 priceModelBulk: '{}' description: description discount: '{}' minimumCommitScope: '{}' minimumCommitProrata: true billableMetricId: billableMetricId priceModelPercentage: '{}' name: name priceModelBasic: '{}' category: '{}' priceModelVolume: '{}' timeUnit: '{}' eulaUrl: eulaUrl billingIntervalInMonths: 4 refundCancellationPolicy: refundCancellationPolicy paymentSchedule: '{}' autoRenew: true currency: currency alibabaEntitlements: - Status: Status ProductName: ProductName EndOn: 5 InstanceId: 2 ProductCode: ProductCode Modules: Module: - Id: Id Properties: Property: - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark DisplayUnit: DisplayUnit Key: Key Name: Name ShowType: ShowType - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark DisplayUnit: DisplayUnit Key: Key Name: Name ShowType: ShowType Code: Code Name: Name - Id: Id Properties: Property: - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark DisplayUnit: DisplayUnit Key: Key Name: Name ShowType: ShowType - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark DisplayUnit: DisplayUnit Key: Key Name: Name ShowType: ShowType Code: Code Name: Name RelationalData: ServiceStatus: ServiceStatus AppJson: AppJson ProductType: ProductType OrderId: 7 Constraints: Constraints AutoRenewal: AutoRenewal ExtendJson: ExtendJson ComponentJson: ComponentJson IsTrial: true SupplierName: SupplierName ProductSkuCode: ProductSkuCode CreatedOn: 5 HostJson: HostJson BeganOn: 1 - Status: Status ProductName: ProductName EndOn: 5 InstanceId: 2 ProductCode: ProductCode Modules: Module: - Id: Id Properties: Property: - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark DisplayUnit: DisplayUnit Key: Key Name: Name ShowType: ShowType - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark DisplayUnit: DisplayUnit Key: Key Name: Name ShowType: ShowType Code: Code Name: Name - Id: Id Properties: Property: - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark DisplayUnit: DisplayUnit Key: Key Name: Name ShowType: ShowType - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark DisplayUnit: DisplayUnit Key: Key Name: Name ShowType: ShowType Code: Code Name: Name RelationalData: ServiceStatus: ServiceStatus AppJson: AppJson ProductType: ProductType OrderId: 7 Constraints: Constraints AutoRenewal: AutoRenewal ExtendJson: ExtendJson ComponentJson: ComponentJson IsTrial: true SupplierName: SupplierName ProductSkuCode: ProductSkuCode CreatedOn: 5 HostJson: HostJson BeganOn: 1 disbursedAmount: 9.369310271410669 netTermsInDays: 3 dimensionsOversized: true eulaType: '' gracePeriodInDays: 8 grossAmount: 9.018348186070783 gcpPlans: - priceInfo: usageFees: - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 subscriptionPlans: - period: period price: nanos: 1 units: units currencyCode: currencyCode - period: period price: nanos: 1 units: units currencyCode: currencyCode description: description priceModel: FREE purchaseMode: PURCHASE_MODE_PRIVATE name: name title: title featureValues: - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription - priceInfo: usageFees: - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 subscriptionPlans: - period: period price: nanos: 1 units: units currencyCode: currencyCode - period: period price: nanos: 1 units: units currencyCode: currencyCode description: description priceModel: FREE purchaseMode: PURCHASE_MODE_PRIVATE name: name title: title featureValues: - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription collectableAmount: 5.025004791520295 buyerManagementURL: buyerManagementURL alertDaysBeforeEnd: 6 sellerNotes: sellerNotes awsAgreement: '{}' billingCycle: '{}' commits: - types: - types - types quantity: 4 length: 9 description: description type: '{}' maximumUsers: 361608 rate: 7.386281948385884 isUserCreated: true minimumUsers: 202713 name: name term: term category: category termEndTime: termEndTime key: key timeUnit: '{}' - types: - types - types quantity: 4 length: 9 description: description type: '{}' maximumUsers: 361608 rate: 7.386281948385884 isUserCreated: true minimumUsers: 202713 name: name term: term category: category termEndTime: termEndTime key: key timeUnit: '{}' isMeteringOverageCommit: true awsChannelPartner: '{}' commitAmount: 9.965781217890562 dimensions: - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 types: - types - types description: description planName: planName usageCount: '{}' rate: 6.84685269835264 includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly valueType: '{}' name: name planId: planId category: category key: key skuId: skuId - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 types: - types - types description: description planName: planName usageCount: '{}' rate: 6.84685269835264 includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly valueType: '{}' name: name planId: planId category: category key: key skuId: skuId snowflakeOffer: '{}' spaUrl: spaUrl info: dimensionQuantityDecimalParts: key: 1.4658129805029452 parentEntitlementTermId: parentEntitlementTermId type: '' subEntitlementTermIds: - subEntitlementTermIds - subEntitlementTermIds isCommitDivided: true lastUpdateTime: lastUpdateTime properties: buyerID: type: string commitAmount: type: number creationTime: type: string creditAmount: type: number endTime: description: nullable format: date-time type: string entitlementID: type: string entitlementInfo: $ref: '#/components/schemas/EntitlementInfo' externalEntitlementID: type: string id: type: string info: $ref: '#/components/schemas/EntitlementTermInfo' lastUpdateTime: type: string offerID: type: string organizationID: type: string partner: $ref: '#/components/schemas/Partner' productID: type: string reportedAmount: type: number service: $ref: '#/components/schemas/PartnerService' startTime: format: date-time type: string usedCommitAmount: type: number usedCreditAmount: type: number type: object WorkloadMetaInfo: example: cppoOfferId: cppoOfferId enableTestUsageMetering: true replacedOfferResourceName: replacedOfferResourceName renewalOfferType: '{}' isAgreementBasedOffer: true isRenewalOffer: true cppoInOfferId: cppoInOfferId aceApnCrmUniqueIdentifier: aceApnCrmUniqueIdentifier testUsageMeteringEndTime: 2000-01-23 04:56:07+00:00 entitlementCancellationSchedule: '{}' isGrossRevenueFullSync: true offerAcceptDate: 2000-01-23 04:56:07+00:00 salesforceOpportunityId: salesforceOpportunityId hubspotDealId: hubspotDealId prettifiedErrorMessages: - prettifiedErrorMessages - prettifiedErrorMessages replacedOfferEndTime: 2000-01-23 04:56:07+00:00 lastModifiedBy: '{}' customMetaInfo: key: customMetaInfo isReplacementOffer: true buyerIds: - buyerIds - buyerIds cppoOutOfferId: cppoOutOfferId errorMessages: - errorMessages - errorMessages baseAgreementId: baseAgreementId internalNote: internalNote salesforceEntitlementURL: salesforceEntitlementURL awsSaasProductDimensions: - Types: - Types - Types Description: Description Length: 2 Rate: 6.778324963048013 TimeUnit: DAY Unit: Unit Key: Key Name: Name - Types: - Types - Types Description: Description Length: 2 Rate: 6.778324963048013 TimeUnit: DAY Unit: Unit Key: Key Name: Name contacts: - name: name company: company email: email - name: name company: company email: email notifications: - eventID: eventID customFields: key: '' entityType: '' contactEmails: - contactEmails - contactEmails entityID: entityID message: message priority: '{}' title: title contactIds: - contactIds - contactIds organizationID: organizationID ccContactIds: - ccContactIds - ccContactIds channels: - EMAIL - EMAIL isActionItem: true partner: '{}' createdBy: '{}' entityStatus: entityStatus entityName: entityName eventStatus: '{}' action: '' requireAudit: true trackEvents: - contactId: contactId action: OPEN_EMAIL timestamp: 2000-01-23 04:56:07+00:00 - contactId: contactId action: OPEN_EMAIL timestamp: 2000-01-23 04:56:07+00:00 info: '{}' lastUpdateTime: 2000-01-23 04:56:07+00:00 timestamp: 2000-01-23 04:56:07+00:00 - eventID: eventID customFields: key: '' entityType: '' contactEmails: - contactEmails - contactEmails entityID: entityID message: message priority: '{}' title: title contactIds: - contactIds - contactIds organizationID: organizationID ccContactIds: - ccContactIds - ccContactIds channels: - EMAIL - EMAIL isActionItem: true partner: '{}' createdBy: '{}' entityStatus: entityStatus entityName: entityName eventStatus: '{}' action: '' requireAudit: true trackEvents: - contactId: contactId action: OPEN_EMAIL timestamp: 2000-01-23 04:56:07+00:00 - contactId: contactId action: OPEN_EMAIL timestamp: 2000-01-23 04:56:07+00:00 info: '{}' lastUpdateTime: 2000-01-23 04:56:07+00:00 timestamp: 2000-01-23 04:56:07+00:00 updateMessage: updateMessage properties: aceApnCrmUniqueIdentifier: description: The linked ACE ApnCrmUniqueIdentifier of the private offer if available. type: string awsSaasProductDimensions: description: 'The AWS SaaS product dimensions. Applicable for AWS SaaS products only. This is used to save price info when creating AWS SaaS product.' items: $ref: '#/components/schemas/AwsProductDimension' type: array baseAgreementId: description: Applicable for AWS Marketplace only, when the IsAgreementBasedOffer is true. type: string buyerIds: description: The Suger buyer IDs of the private offer if available. items: type: string type: array contacts: description: The contacts of the offer to notify if any updates. items: $ref: '#/components/schemas/Contact' type: array cppoInOfferId: description: The Suger CPPO_IN offer ID. type: string cppoOfferId: description: The Suger CPPO offer ID. Reseller to end buyer type: string cppoOutOfferId: description: The Suger CPPO_OUT offer ID. ISV to reseller type: string customMetaInfo: additionalProperties: type: string description: The custom meta info of the offer can be updated by seller via API or console. type: object enableTestUsageMetering: description: If enabled, Suger will test metering the usage for this entitlement hourly. type: boolean entitlementCancellationSchedule: allOf: - $ref: '#/components/schemas/CancellationSchedule' description: The cancellation schedule for the entitlement. It is nill if no cancellation schedule. type: object errorMessages: description: 'The error messages when the offer is invalid or offer related tasks failed. This is the raw error messages from the offer related tasks.' items: type: string type: array hubspotDealId: description: Hubsport deal ID of the private offer if available. type: string internalNote: description: 'The Internal note of the private offer. It is only visible to the seller/ISV, not visible to the buyer. Up to 1000 characters.' type: string isAgreementBasedOffer: description: Applicable for AWS Marketplace only, If this offer is agreement based offer. type: boolean isGrossRevenueFullSync: description: Whether the gross revenue is fully synced for the entitlement. type: boolean isRenewalOffer: description: 'Applicable for AWS Marketplace only. If this offer is renewal offer of existing agreement. The existing agreement can be within or outside AWS Marketplace. AWS may audit and verify your offer is a renewal. If AWS is unable to verify your offer, then AWS may revoke the offer and entitlements from your customer.' type: boolean isReplacementOffer: description: If this offer is a GCP replacement offer. Applicable for GCP Marketplace replacement offer only. type: boolean lastModifiedBy: allOf: - $ref: '#/components/schemas/LastModifiedBy' description: The user who last modified the product/offer/buyer/contact. type: object notifications: description: 'The notifications of the offer if any updates. In most cases, it is to notify contacts/buyers when the offer is pending acceptance.' items: $ref: '#/components/schemas/NotificationEvent' type: array offerAcceptDate: description: The date when the offer is accepted by the buyer. Only available when the private offer has been accepted. format: date-time type: string prettifiedErrorMessages: description: 'The prettified ErrorMessages. Using AI to make it more readable and understandable. The prettified error messages will be used for the offer related UI display.' items: type: string type: array renewalOfferType: allOf: - $ref: '#/components/schemas/AwsRenewalOfferType' description: Applicable for AWS Marketplace only, required when the IsRenewalOffer is true. type: object replacedOfferEndTime: description: The end time of the replaced offer. Applicable for GCP Marketplace replacement offer only. format: date-time type: string replacedOfferResourceName: description: 'The resource name of the GCP Marketplace offer that this offer is replacing. In format of "projects/{gcpProjectNumber}/services/{productServiceName}/privateOffers/{privateOfferId}" Applicable for GCP Marketplace replacement offer only.' type: string salesforceEntitlementURL: description: The Salesforce entitlement URL type: string salesforceOpportunityId: description: The Salesforce opportunity ID of the private offer if available. type: string testUsageMeteringEndTime: description: 'The test usage metering end time. It is used for test usage metering only. Required if EnableTestUsageMetering is true.' format: date-time type: string updateMessage: description: The message to notify when the offer is updated. type: string type: object WorkloadOffer: example: lastUpdatedBy: lastUpdatedBy creationTime: 2000-01-23 04:56:07+00:00 productID: productID externalID: externalID buyerID: buyerID contactIds: - contactIds - contactIds organizationID: organizationID offerType: UNKNOWN metaInfo: cppoOfferId: cppoOfferId enableTestUsageMetering: true replacedOfferResourceName: replacedOfferResourceName renewalOfferType: '{}' isAgreementBasedOffer: true isRenewalOffer: true cppoInOfferId: cppoInOfferId aceApnCrmUniqueIdentifier: aceApnCrmUniqueIdentifier testUsageMeteringEndTime: 2000-01-23 04:56:07+00:00 entitlementCancellationSchedule: '{}' isGrossRevenueFullSync: true offerAcceptDate: 2000-01-23 04:56:07+00:00 salesforceOpportunityId: salesforceOpportunityId hubspotDealId: hubspotDealId prettifiedErrorMessages: - prettifiedErrorMessages - prettifiedErrorMessages replacedOfferEndTime: 2000-01-23 04:56:07+00:00 lastModifiedBy: '{}' customMetaInfo: key: customMetaInfo isReplacementOffer: true buyerIds: - buyerIds - buyerIds cppoOutOfferId: cppoOutOfferId errorMessages: - errorMessages - errorMessages baseAgreementId: baseAgreementId internalNote: internalNote salesforceEntitlementURL: salesforceEntitlementURL awsSaasProductDimensions: - Types: - Types - Types Description: Description Length: 2 Rate: 6.778324963048013 TimeUnit: DAY Unit: Unit Key: Key Name: Name - Types: - Types - Types Description: Description Length: 2 Rate: 6.778324963048013 TimeUnit: DAY Unit: Unit Key: Key Name: Name contacts: - name: name company: company email: email - name: name company: company email: email notifications: - eventID: eventID customFields: key: '' entityType: '' contactEmails: - contactEmails - contactEmails entityID: entityID message: message priority: '{}' title: title contactIds: - contactIds - contactIds organizationID: organizationID ccContactIds: - ccContactIds - ccContactIds channels: - EMAIL - EMAIL isActionItem: true partner: '{}' createdBy: '{}' entityStatus: entityStatus entityName: entityName eventStatus: '{}' action: '' requireAudit: true trackEvents: - contactId: contactId action: OPEN_EMAIL timestamp: 2000-01-23 04:56:07+00:00 - contactId: contactId action: OPEN_EMAIL timestamp: 2000-01-23 04:56:07+00:00 info: '{}' lastUpdateTime: 2000-01-23 04:56:07+00:00 timestamp: 2000-01-23 04:56:07+00:00 - eventID: eventID customFields: key: '' entityType: '' contactEmails: - contactEmails - contactEmails entityID: entityID message: message priority: '{}' title: title contactIds: - contactIds - contactIds organizationID: organizationID ccContactIds: - ccContactIds - ccContactIds channels: - EMAIL - EMAIL isActionItem: true partner: '{}' createdBy: '{}' entityStatus: entityStatus entityName: entityName eventStatus: '{}' action: '' requireAudit: true trackEvents: - contactId: contactId action: OPEN_EMAIL timestamp: 2000-01-23 04:56:07+00:00 - contactId: contactId action: OPEN_EMAIL timestamp: 2000-01-23 04:56:07+00:00 info: '{}' lastUpdateTime: 2000-01-23 04:56:07+00:00 timestamp: 2000-01-23 04:56:07+00:00 updateMessage: updateMessage expireTime: 2000-01-23 04:56:07+00:00 partner: '' createdBy: createdBy service: DEFAULT name: name endTime: 2000-01-23 04:56:07+00:00 id: id partnerID: partnerID info: awsResaleAuthorizationId: awsResaleAuthorizationId additionalResellerEulaUrls: - additionalResellerEulaUrls - additionalResellerEulaUrls gcpSowAgreementDocument: '{}' resellerEulaUrl: resellerEulaUrl trialConfig: '{}' taxIds: - taxIds - taxIds paymentInstallments: - discountPercentage: 3.5571952270680973 amount: 9.018348186070783 originalAmount: 6.965117697638846 chargeOn: 2000-01-23 04:56:07+00:00 chargeOnStr: chargeOnStr credit: 6.438423552598547 - discountPercentage: 3.5571952270680973 amount: 9.018348186070783 originalAmount: 6.965117697638846 chargeOn: 2000-01-23 04:56:07+00:00 chargeOnStr: chargeOnStr credit: 6.438423552598547 billableDimensions: - priceModelTiered: '{}' priceModelTieredPercentage: '{}' priceModelMatrix: '{}' minimumCommit: 5.962133916683182 length: 1 priceModelBulk: '{}' description: description discount: '{}' minimumCommitScope: '{}' minimumCommitProrata: true billableMetricId: billableMetricId priceModelPercentage: '{}' name: name priceModelBasic: '{}' category: '{}' priceModelVolume: '{}' timeUnit: '{}' - priceModelTiered: '{}' priceModelTieredPercentage: '{}' priceModelMatrix: '{}' minimumCommit: 5.962133916683182 length: 1 priceModelBulk: '{}' description: description discount: '{}' minimumCommitScope: '{}' minimumCommitProrata: true billableMetricId: billableMetricId priceModelPercentage: '{}' name: name priceModelBasic: '{}' category: '{}' priceModelVolume: '{}' timeUnit: '{}' eulaUrl: eulaUrl attachEulaType: '{}' buyerAzureTenants: - description: description id: id - description: description id: id awsAgreementDuration: awsAgreementDuration refundCancellationPolicy: refundCancellationPolicy paymentSchedule: '{}' eulaMergeOrder: - 1 - 1 azureOriginalPlan: '{}' gcpPrivateOffer: '{}' netTermsInDays: 8 azureProductVariant: '{}' gcpResellerPrivateOfferPlan: offerTemplatePolicies: allowScheduledStartDate: true allowAutoRenewal: true maxRenewalTimes: maxRenewalTimes offerDealType: OFFER_DEAL_TYPE_UNSPECIFIED proration: PRORATION_UNSPECIFIED displayName: displayName agreementDocuments: isvToCustomerAgreementDocument: documentBody: documentBody documentType: documentType unstructuredDocument: content: content name: name description: description updateTime: 2000-01-23 04:56:07+00:00 externalGoogleLink: '{}' isvToResellerAgreementDocument: documentBody: documentBody documentType: documentType unstructuredDocument: content: content name: name description: description updateTime: 2000-01-23 04:56:07+00:00 externalGoogleLink: '{}' features: - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription isvInfo: contactEmail: contactEmail contactName: contactName partnerAdvantageAccountLegalName: partnerAdvantageAccountLegalName partnerAdvantageId: partnerAdvantageId paymentSchedule: '' installmentTimelineTemplate: installmentTemplates: - priceModelTemplate: baseOffer: baseOffer commitment: commitmentAmountPerPeriodTemplate: decimalAmountConstraint: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units currencyCode: currencyCode period: unit: MONTHLY_PERIOD count: 9 discountTemplate: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode consumption: overage payg: period: unit: MONTHLY_PERIOD count: 9 discountTemplate: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode skuDiscountTemplates: - '{}' - '{}' skuRepresentation: skuList: skus: - skus - skus skus: skus skuGroupList: '{}' subscription: fixedPrice fixedPrice: period: unit: MONTHLY_PERIOD count: 9 discountTemplate: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode overage: discountTemplate: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode skuDiscountTemplates: - '{}' - '{}' skuRepresentation: skuList: skus: - skus - skus skus: skus skuGroupList: '{}' startTime: 2000-01-23 04:56:07+00:00 - priceModelTemplate: baseOffer: baseOffer commitment: commitmentAmountPerPeriodTemplate: decimalAmountConstraint: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units currencyCode: currencyCode period: unit: MONTHLY_PERIOD count: 9 discountTemplate: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode consumption: overage payg: period: unit: MONTHLY_PERIOD count: 9 discountTemplate: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode skuDiscountTemplates: - '{}' - '{}' skuRepresentation: skuList: skus: - skus - skus skus: skus skuGroupList: '{}' subscription: fixedPrice fixedPrice: period: unit: MONTHLY_PERIOD count: 9 discountTemplate: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode overage: discountTemplate: discountPercentage: minAmount: nanos: 9 units: units defaultAmount: nanos: 9 units: units maxAmount: nanos: 9 units: units discountEconomics: discountEconomics hideDiscountPercentage: true discountedPrice: nanos: 1 units: units currencyCode: currencyCode skuDiscountTemplates: - '{}' - '{}' skuRepresentation: skuList: skus: - skus - skus skus: skus skuGroupList: '{}' startTime: 2000-01-23 04:56:07+00:00 state: cancellationReason: '{}' stateType: '' comment: comment rejectionReason: '{}' stateTransitions: - transitionTime: 2000-01-23 04:56:07+00:00 newState: stateType: null - transitionTime: 2000-01-23 04:56:07+00:00 newState: stateType: null reusePolicy: '' margin: marginPercentage: value: value agreement: agreement durationConfig: startTime: 2000-01-23 04:56:07+00:00 endTime: 2000-01-23 04:56:07+00:00 priceModelTemplate: '{}' startPolicy: '' updateTime: 2000-01-23 04:56:07+00:00 productInfo: flavorExternalName: flavorExternalName providerId: providerId serviceLevel: serviceLevel serviceName: serviceName productExternalName: productExternalName metaInfo: gcpOrganizationId: gcpOrganizationId gcpProjectNumber: gcpProjectNumber resellerInfo: billingAccountOrgDisplayName: billingAccountOrgDisplayName resellerPrivateOfferPlanScope: resellerPrivateOfferPlanScope partnerAccountName: partnerAccountName notesToReseller: notesToReseller resellerContactName: resellerContactName resellOfferTemplateId: resellOfferTemplateId billingAccountId: billingAccountId billingAccountType: billingAccountType billingAccountNickname: billingAccountNickname resellerContactEmail: resellerContactEmail resellerPrivateOfferPlanId: resellerPrivateOfferPlanId subBillingAccount: subBillingAccount name: name resellOfferTemplate: resellOfferTemplate replacementMetadata: '{}' acceptanceDeadlineTime: 2000-01-23 04:56:07+00:00 amendmentContext: '{}' offerTermTemplate: paymentRecurrence: paymentRecurrence termDurationConstraint: defaultDuration: unit: MONTHLY_PERIOD count: 9 startPolicy: '' startTime: 2000-01-23 04:56:07+00:00 endTime: 2000-01-23 04:56:07+00:00 enableScheduledStartTimes: true termDuration: unit: MONTHLY_PERIOD count: 9 visibility: PRIVATE eulaType: '' awsMarkupPercentage: 6.027456183070403 gracePeriodInDays: 6 gcpOfferDealType: '{}' gcpCustomerInfo: '{}' gcpProviderPublicNote: gcpProviderPublicNote gcpDuration: 4 billingCycle: '{}' gcpMetrics: - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 displayUnitDescription: displayUnitDescription unit: unit metricKind: metricKind displayName: displayName valueType: '{}' name: name description: description displayUnit: displayUnit id: id reportingUnit: reportingUnit skuId: skuId - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 displayUnitDescription: displayUnitDescription unit: unit metricKind: metricKind displayName: displayName valueType: '{}' name: name description: description displayUnit: displayUnit id: id reportingUnit: reportingUnit skuId: skuId commits: - types: - types - types quantity: 4 length: 9 description: description type: '{}' maximumUsers: 361608 rate: 7.386281948385884 isUserCreated: true minimumUsers: 202713 name: name term: term category: category termEndTime: termEndTime key: key timeUnit: '{}' - types: - types - types quantity: 4 length: 9 description: description type: '{}' maximumUsers: 361608 rate: 7.386281948385884 isUserCreated: true minimumUsers: 202713 name: name term: term category: category termEndTime: termEndTime key: key timeUnit: '{}' isMeteringOverageCommit: true proratedBilling: true awsChannelPartner: '{}' awsCppoOpportunity: '{}' usageBillingIntervalInMonths: 1 privateOfferUrl: privateOfferUrl discountPercentage: 7.457744773683766 pdfURL: pdfURL awsMachineLearningContractDuration: 0 commitBillingIntervalInMonths: 7 docusignEnvelopeIds: key: docusignEnvelopeIds billingIntervalInMonths: 5 gcpProviderInfo: '{}' autoRenew: true currency: currency startTime: 2000-01-23 04:56:07+00:00 azurePrivateOffer: '{}' gcpPaymentSchedule: '{}' gcpProviderInternalNote: gcpProviderInternalNote gcpPlans: - priceInfo: usageFees: - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 subscriptionPlans: - period: period price: nanos: 1 units: units currencyCode: currencyCode - period: period price: nanos: 1 units: units currencyCode: currencyCode description: description priceModel: FREE purchaseMode: PURCHASE_MODE_PRIVATE name: name title: title featureValues: - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription - priceInfo: usageFees: - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 subscriptionPlans: - period: period price: nanos: 1 units: units currencyCode: currencyCode - period: period price: nanos: 1 units: units currencyCode: currencyCode description: description priceModel: FREE purchaseMode: PURCHASE_MODE_PRIVATE name: name title: title featureValues: - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription resellerAttachEulaType: '{}' awsCppoEventDetail: '{}' sellerNotes: sellerNotes buyerAwsAccountIds: - buyerAwsAccountIds - buyerAwsAccountIds gcpUsagePlanPriceModel: '{}' additionalEulaUrls: - additionalEulaUrls - additionalEulaUrls resellerEulaType: '{}' commitAmount: 2.3021358869347655 dimensions: - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 types: - types - types description: description planName: planName usageCount: '{}' rate: 6.84685269835264 includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly valueType: '{}' name: name planId: planId category: category key: key skuId: skuId - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 types: - types - types description: description planName: planName usageCount: '{}' rate: 6.84685269835264 includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly valueType: '{}' name: name planId: planId category: category key: key skuId: skuId snowflakeOffer: '{}' lastUpdateTime: 2000-01-23 04:56:07+00:00 status: '' properties: buyerID: type: string contactIds: items: type: string type: array createdBy: type: string creationTime: format: date-time type: string endTime: description: nullable format: date-time type: string expireTime: description: nullable format: date-time type: string externalID: type: string id: type: string info: $ref: '#/components/schemas/OfferInfo' lastUpdateTime: format: date-time type: string lastUpdatedBy: type: string metaInfo: $ref: '#/components/schemas/WorkloadMetaInfo' name: type: string offerType: $ref: '#/components/schemas/OfferType' organizationID: type: string partner: $ref: '#/components/schemas/Partner' partnerID: type: string productID: type: string service: $ref: '#/components/schemas/PartnerService' status: $ref: '#/components/schemas/OfferStatus' type: object WorkloadProduct: example: lastUpdatedBy: lastUpdatedBy fulfillmentUrl: fulfillmentUrl creationTime: 2000-01-23 04:56:07+00:00 externalID: externalID organizationID: organizationID metaInfo: cppoOfferId: cppoOfferId enableTestUsageMetering: true replacedOfferResourceName: replacedOfferResourceName renewalOfferType: '{}' isAgreementBasedOffer: true isRenewalOffer: true cppoInOfferId: cppoInOfferId aceApnCrmUniqueIdentifier: aceApnCrmUniqueIdentifier testUsageMeteringEndTime: 2000-01-23 04:56:07+00:00 entitlementCancellationSchedule: '{}' isGrossRevenueFullSync: true offerAcceptDate: 2000-01-23 04:56:07+00:00 salesforceOpportunityId: salesforceOpportunityId hubspotDealId: hubspotDealId prettifiedErrorMessages: - prettifiedErrorMessages - prettifiedErrorMessages replacedOfferEndTime: 2000-01-23 04:56:07+00:00 lastModifiedBy: '{}' customMetaInfo: key: customMetaInfo isReplacementOffer: true buyerIds: - buyerIds - buyerIds cppoOutOfferId: cppoOutOfferId errorMessages: - errorMessages - errorMessages baseAgreementId: baseAgreementId internalNote: internalNote salesforceEntitlementURL: salesforceEntitlementURL awsSaasProductDimensions: - Types: - Types - Types Description: Description Length: 2 Rate: 6.778324963048013 TimeUnit: DAY Unit: Unit Key: Key Name: Name - Types: - Types - Types Description: Description Length: 2 Rate: 6.778324963048013 TimeUnit: DAY Unit: Unit Key: Key Name: Name contacts: - name: name company: company email: email - name: name company: company email: email notifications: - eventID: eventID customFields: key: '' entityType: '' contactEmails: - contactEmails - contactEmails entityID: entityID message: message priority: '{}' title: title contactIds: - contactIds - contactIds organizationID: organizationID ccContactIds: - ccContactIds - ccContactIds channels: - EMAIL - EMAIL isActionItem: true partner: '{}' createdBy: '{}' entityStatus: entityStatus entityName: entityName eventStatus: '{}' action: '' requireAudit: true trackEvents: - contactId: contactId action: OPEN_EMAIL timestamp: 2000-01-23 04:56:07+00:00 - contactId: contactId action: OPEN_EMAIL timestamp: 2000-01-23 04:56:07+00:00 info: '{}' lastUpdateTime: 2000-01-23 04:56:07+00:00 timestamp: 2000-01-23 04:56:07+00:00 - eventID: eventID customFields: key: '' entityType: '' contactEmails: - contactEmails - contactEmails entityID: entityID message: message priority: '{}' title: title contactIds: - contactIds - contactIds organizationID: organizationID ccContactIds: - ccContactIds - ccContactIds channels: - EMAIL - EMAIL isActionItem: true partner: '{}' createdBy: '{}' entityStatus: entityStatus entityName: entityName eventStatus: '{}' action: '' requireAudit: true trackEvents: - contactId: contactId action: OPEN_EMAIL timestamp: 2000-01-23 04:56:07+00:00 - contactId: contactId action: OPEN_EMAIL timestamp: 2000-01-23 04:56:07+00:00 info: '{}' lastUpdateTime: 2000-01-23 04:56:07+00:00 timestamp: 2000-01-23 04:56:07+00:00 updateMessage: updateMessage partner: '' createdBy: createdBy service: DEFAULT name: name id: id partnerID: partnerID productType: UNKNOWN info: eulaType: '{}' awsSaasProduct: Repositories: - Type: Type Url: Url - Type: Type Url: Url Description: UsW9Submitted: true Highlights: - Highlights - Highlights Categories: - Categories - Categories ProductCode: ProductCode SearchKeywords: - SearchKeywords - SearchKeywords ProductTitle: ProductTitle EuW8Submitted: true ShortDescription: ShortDescription LongDescription: LongDescription Manufacturer: Manufacturer Visibility: Limited AssociatedProducts: '{}' Sku: Sku Registered: true Versions: - CreationDate: 2000-01-23 04:56:07+00:00 Id: Id DeliveryOptions: - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription ReleaseNotes: ReleaseNotes VersionTitle: VersionTitle - CreationDate: 2000-01-23 04:56:07+00:00 Id: Id DeliveryOptions: - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription ReleaseNotes: ReleaseNotes VersionTitle: VersionTitle productId: productId PromotionalResources: AdditionalResources: - Type: Type Text: Text Url: Url - Type: Type Text: Text Url: Url LogoUrl: LogoUrl Videos: - Type: Type Title: Title Url: Url - Type: Type Title: Title Url: Url dataFeedProductId: dataFeedProductId Dimensions: - Types: - Types - Types Description: Description Length: 2 Rate: 6.778324963048013 TimeUnit: DAY Unit: Unit Key: Key Name: Name - Types: - Types - Types Description: Description Length: 2 Rate: 6.778324963048013 TimeUnit: DAY Unit: Unit Key: Key Name: Name SignatureVerificationKeys: - Status: Status PublicKey: PublicKey PublicKeyVersion: 2 - Status: Status PublicKey: PublicKey PublicKeyVersion: 2 SupportInformation: Description: Description awsContainerProduct: Repositories: - Type: Type Url: Url - Type: Type Url: Url Description: UsW9Submitted: true Highlights: - Highlights - Highlights Categories: - Categories - Categories ProductCode: ProductCode SearchKeywords: - SearchKeywords - SearchKeywords ProductTitle: ProductTitle EuW8Submitted: true ShortDescription: ShortDescription LongDescription: LongDescription Manufacturer: Manufacturer Visibility: Limited AssociatedProducts: '{}' Sku: Sku Registered: true Versions: - CreationDate: 2000-01-23 04:56:07+00:00 Id: Id DeliveryOptions: - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription ReleaseNotes: ReleaseNotes VersionTitle: VersionTitle - CreationDate: 2000-01-23 04:56:07+00:00 Id: Id DeliveryOptions: - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription ReleaseNotes: ReleaseNotes VersionTitle: VersionTitle productId: productId PromotionalResources: AdditionalResources: - Type: Type Text: Text Url: Url - Type: Type Text: Text Url: Url LogoUrl: LogoUrl Videos: - Type: Type Title: Title Url: Url - Type: Type Title: Title Url: Url dataFeedProductId: dataFeedProductId Dimensions: - Types: - Types - Types Description: Description Length: 2 Rate: 6.778324963048013 TimeUnit: DAY Unit: Unit Key: Key Name: Name - Types: - Types - Types Description: Description Length: 2 Rate: 6.778324963048013 TimeUnit: DAY Unit: Unit Key: Key Name: Name SignatureVerificationKeys: - Status: Status PublicKey: PublicKey PublicKeyVersion: 2 - Status: Status PublicKey: PublicKey PublicKeyVersion: 2 SupportInformation: Description: Description alibabaProduct: FrontCategoryId: 6 Status: Status Description: Description RequestId: RequestId ShopInfo: WangWangs: WangWang: - UserName: UserName Remark: Remark - UserName: UserName Remark: Remark Telephones: Telephone: - Telephone - Telephone Emails: Emails Id: 7 Name: Name ProductSkus: ProductSku: - Constraints: Constraints ChargeType: ChargeType Modules: Module: - Id: Id Properties: Property: - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name Code: Code Name: Name - Id: Id Properties: Property: - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name Code: Code Name: Name OrderPeriods: OrderPeriod: - PeriodType: PeriodType Name: Name - PeriodType: PeriodType Name: Name Hidden: true Code: Code Name: Name - Constraints: Constraints ChargeType: ChargeType Modules: Module: - Id: Id Properties: Property: - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name Code: Code Name: Name - Id: Id Properties: Property: - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark showType: showType DisplayUnit: DisplayUnit Key: Key Name: Name Code: Code Name: Name OrderPeriods: OrderPeriod: - PeriodType: PeriodType Name: Name - PeriodType: PeriodType Name: Name Hidden: true Code: Code Name: Name UseCount: 3 GmtModified: 5 GmtCreated: 1 Code: Code Name: Name ShortDescription: ShortDescription SupplierPk: 9 Score: 2.3021358869347655 Type: Type AuditStatus: AuditStatus AuditFailMsg: AuditFailMsg ProductExtras: ProductExtra: - Order: 5 Type: Type Label: Label Values: '{}' Key: Key - Order: 5 Type: Type Label: Label Values: '{}' Key: Key AuditTime: 0 PicUrl: PicUrl awsSnsSubscriptions: - Status: UNKNOWN Endpoint: Endpoint TopicArn: TopicArn Protocol: Protocol SubscriptionArn: SubscriptionArn - Status: UNKNOWN Endpoint: Endpoint TopicArn: TopicArn Protocol: Protocol SubscriptionArn: SubscriptionArn azureProductResource: customerLeads: salesforceLeadConfiguration: '{}' product: product $schema: $schema tableLeadConfiguration: '{}' httpsEndpointLeadConfiguration: '{}' resourceName: resourceName emailLeadConfiguration: '{}' dynamicsLeadConfiguration: '{}' marketoLeadConfiguration: '{}' leadDestination: none id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message blobLeadConfiguration: '{}' product: lifecycleState: null $schema: $schema productGroup: productGroup identity: externalId: externalId alias: alias resourceName: resourceName id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message type: azureApplication priceAndAvailabilityOffer: product: product $schema: $schema previewAudiences: - id: id label: label type: none - id: id label: label type: none resourceName: resourceName id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message technicalConfiguration: azureAdTenantId: azureAdTenantId product: product $schema: $schema azureAdAppId: azureAdAppId resourceName: resourceName id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message connectionWebhook: connectionWebhook landingPageUrl: landingPageUrl listingAssets: - lifecycleState: '{}' fileName: fileName product: product $schema: $schema kind: azure displayOrder: 6 languageId: languageId description: description resourceName: resourceName type: azureLogoSmall url: url id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message listing: listing friendlyName: friendlyName - lifecycleState: '{}' fileName: fileName product: product $schema: $schema kind: azure displayOrder: 6 languageId: languageId description: description resourceName: resourceName type: azureLogoSmall url: url id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message listing: listing friendlyName: friendlyName plans: - planListing: summary: summary lifecycleState: null product: product $schema: $schema kind: azureVM-plan languageId: languageId name: name description: description resourceName: resourceName id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message plan: plan priceAndAvailabilityPlan: audience: public product: product softwareReservation: - percentageSave: 6.704019297950036 term: 3.353193347011243 type: month - percentageSave: 6.704019297950036 term: 3.353193347011243 type: month $schema: $schema visibility: visible meterDefine: meterDefine billingTag: billingTag resourceName: resourceName trial: type: day value: 7.386281948385884 markets: - markets - markets privateAudiences: - id: id label: label type: none - id: id label: label type: none id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message plan: plan pricing: customMeters: priceInputOption: perMarket meters: key: pricePerPaymentInUsd: 6.778324963048013 includedQuantities: - quantity: 2.8841621266687802 isInfinite: true billingTerm: type: day value: 7.386281948385884 - quantity: 2.8841621266687802 isInfinite: true billingTerm: type: day value: 7.386281948385884 billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - pricePerPaymentInUsd: 6.878052220127876 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency - pricePerPaymentInUsd: 6.878052220127876 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency licenseModel: byol systemMeterPricing: price: 5.944895607614016 priceInputOption: perCore prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency corePricing: price: 6.965117697638846 priceInputOption: free pricePerCoreSize: '{}' pricePerCore: 1.284659006116532 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency recurrentPrice: recurrentPriceMode: flatRate userLimits: min: 6.84685269835264 max: 1.4894159098541704 priceInputOption: perMarket prices: - billingFrequency: '{}' pricePerPaymentInUsd: 1.2315135367772556 flexibleSchedule: '{}' contractDuration: '{}' billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency - billingFrequency: '{}' pricePerPaymentInUsd: 1.2315135367772556 flexibleSchedule: '{}' contractDuration: '{}' billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency plan: deprecationSchedule: date: date reason: criticalSecurityIssue $schema: $schema alternative: product: '{}' plan: '{}' dateOffset: dateOffset lifecycleState: null product: product displayRank: 3 $schema: $schema azureGovernmentCertifications: - link: link name: name - link: link name: name resourceName: resourceName azureRegions: - azureRegions - azureRegions subtype: managedApplication identity: externalId: externalId alias: alias id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - planListing: summary: summary lifecycleState: null product: product $schema: $schema kind: azureVM-plan languageId: languageId name: name description: description resourceName: resourceName id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message plan: plan priceAndAvailabilityPlan: audience: public product: product softwareReservation: - percentageSave: 6.704019297950036 term: 3.353193347011243 type: month - percentageSave: 6.704019297950036 term: 3.353193347011243 type: month $schema: $schema visibility: visible meterDefine: meterDefine billingTag: billingTag resourceName: resourceName trial: type: day value: 7.386281948385884 markets: - markets - markets privateAudiences: - id: id label: label type: none - id: id label: label type: none id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message plan: plan pricing: customMeters: priceInputOption: perMarket meters: key: pricePerPaymentInUsd: 6.778324963048013 includedQuantities: - quantity: 2.8841621266687802 isInfinite: true billingTerm: type: day value: 7.386281948385884 - quantity: 2.8841621266687802 isInfinite: true billingTerm: type: day value: 7.386281948385884 billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - pricePerPaymentInUsd: 6.878052220127876 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency - pricePerPaymentInUsd: 6.878052220127876 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency licenseModel: byol systemMeterPricing: price: 5.944895607614016 priceInputOption: perCore prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency corePricing: price: 6.965117697638846 priceInputOption: free pricePerCoreSize: '{}' pricePerCore: 1.284659006116532 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency recurrentPrice: recurrentPriceMode: flatRate userLimits: min: 6.84685269835264 max: 1.4894159098541704 priceInputOption: perMarket prices: - billingFrequency: '{}' pricePerPaymentInUsd: 1.2315135367772556 flexibleSchedule: '{}' contractDuration: '{}' billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency - billingFrequency: '{}' pricePerPaymentInUsd: 1.2315135367772556 flexibleSchedule: '{}' contractDuration: '{}' billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency plan: deprecationSchedule: date: date reason: criticalSecurityIssue $schema: $schema alternative: product: '{}' plan: '{}' dateOffset: dateOffset lifecycleState: null product: product displayRank: 3 $schema: $schema azureGovernmentCertifications: - link: link name: name - link: link name: name resourceName: resourceName azureRegions: - azureRegions - azureRegions subtype: managedApplication identity: externalId: externalId alias: alias id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message property: lifecycleState: null appVersion: appVersion product: product $schema: $schema termsConditions: custom kind: azureSaaS resourceName: resourceName customAmendments: - tenants: manualEntries: - description: description id: id - description: description id: id terms: terms - tenants: manualEntries: - description: description id: id - description: description id: id terms: terms cloudIndustries: key: - cloudIndustries - cloudIndustries standardContractAmendment: standardContractAmendment termsOfUseUrl: termsOfUseUrl termsOfUse: termsOfUse industries: key: - industries - industries categories: key: - categories - categories id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message reseller: product: product $schema: $schema resellerChannelState: resellerChannelState audiences: - resourceId: resourceId description: description type: subscription - resourceId: resourceId description: description type: subscription resourceName: resourceName id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message setup: product: product $schema: $schema accessUrl: accessUrl useMicrosoftLicenseManagementService: true sellThroughMicrosoft: true resourceName: resourceName id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message requireLicenseForInstall: true callToAction: free submission: result: succeeded deprecationSchedule: date: date reason: criticalSecurityIssue $schema: $schema alternative: product: '{}' plan: '{}' dateOffset: dateOffset lifecycleState: null product: product $schema: $schema created: created resourceName: resourceName id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message status: notStarted target: targetId: targetId targetType: flight listing: generalLinks: - displayText: displayText link: link - displayText: displayText link: link lifecycleState: '{}' cloudSolutionProviderMarketingMaterials: cloudSolutionProviderMarketingMaterials product: product supportContact: phone: phone name: name email: email url: url governmentSupportWebsite: governmentSupportWebsite $schema: $schema searchKeywords: - searchKeywords - searchKeywords kind: azureSaaS languageId: languageId description: description resourceName: resourceName shortDescription: shortDescription title: title privacyPolicyLink: privacyPolicyLink gettingStartedInstructions: gettingStartedInstructions gloabalSupportWebsite: gloabalSupportWebsite cloudSolutionProviderContact: phone: phone name: name email: email url: url engineeringContact: phone: phone name: name email: email url: url id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message searchResultSummary: searchResultSummary priceAndAvailabilityCustomMeter: product: product $schema: $schema customMeters: key: unitOfMeasure: unitOfMeasure displayName: displayName price: 3.0937452626664474 resourceName: resourceName id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message awsAmiProduct: Repositories: - Type: Type Url: Url - Type: Type Url: Url Description: UsW9Submitted: true Highlights: - Highlights - Highlights Categories: - Categories - Categories ProductCode: ProductCode SearchKeywords: - SearchKeywords - SearchKeywords ProductTitle: ProductTitle EuW8Submitted: true ShortDescription: ShortDescription LongDescription: LongDescription Manufacturer: Manufacturer Visibility: Limited AssociatedProducts: '{}' Sku: Sku Registered: true Versions: - CreationDate: 2000-01-23 04:56:07+00:00 Id: Id DeliveryOptions: - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription ReleaseNotes: ReleaseNotes VersionTitle: VersionTitle - CreationDate: 2000-01-23 04:56:07+00:00 Id: Id DeliveryOptions: - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription ReleaseNotes: ReleaseNotes VersionTitle: VersionTitle productId: productId PromotionalResources: AdditionalResources: - Type: Type Text: Text Url: Url - Type: Type Text: Text Url: Url LogoUrl: LogoUrl Videos: - Type: Type Title: Title Url: Url - Type: Type Title: Title Url: Url dataFeedProductId: dataFeedProductId Dimensions: - Types: - Types - Types Description: Description Length: 2 Rate: 6.778324963048013 TimeUnit: DAY Unit: Unit Key: Key Name: Name - Types: - Types - Types Description: Description Length: 2 Rate: 6.778324963048013 TimeUnit: DAY Unit: Unit Key: Key Name: Name SignatureVerificationKeys: - Status: Status PublicKey: PublicKey PublicKeyVersion: 2 - Status: Status PublicKey: PublicKey PublicKeyVersion: 2 SupportInformation: Description: Description eulaUrl: eulaUrl sellerNotes: sellerNotes snowflakeProduct: profileName: profileName evaluationPlan: evaluationPlan metadata: hasFreeSampleData: true areTermsProvidedOffline: true usage: '{}' description: description businessNeeds: '{}' share: share paidAttributes: '{}' title: title isWithStandardTerms: true private: true additionalRegions: additionalRegions globalName: globalName regions: regions autofulfillment: true flags: flags pricingPlans: - updated_on: updated_on billing_duration_months: '0' metadata: key: metadata visibility: visibility display_name: display_name usage_details: free_unit_kind: free_unit_kind free_units: 5.533258397034986 usage_unit_kind: usage_unit_kind max_fee: 3.2588565619047607 usage_unit_price: 4.078845849666752 base_fee: 7.04836565559697 contract_type: contract_type sales_motion: sales_motion pricing_model: pricing_model name: name comment: comment currency: currency state: state contract_duration_months: '0' - updated_on: updated_on billing_duration_months: '0' metadata: key: metadata visibility: visibility display_name: display_name usage_details: free_unit_kind: free_unit_kind free_units: 5.533258397034986 usage_unit_kind: usage_unit_kind max_fee: 3.2588565619047607 usage_unit_price: 4.078845849666752 base_fee: 7.04836565559697 contract_type: contract_type sales_motion: sales_motion pricing_model: pricing_model name: name comment: comment currency: currency state: state contract_duration_months: '0' listingType: listingType distribution: distribution createdOn: createdOn customizedContactInfo: customizedContactInfo fulfillmentType: fulfillmentType shareType: shareType unpublishedByAdminReason: unpublishedByAdminReason scheduledDropTime: scheduledDropTime firstPublishedOn: firstPublishedOn isMountlessQueryable: true state: state attachedShare: attachedShare detailedTargetAccounts: - company_name: company_name account_identifier: account_identifier - company_name: company_name account_identifier: account_identifier publishOnApproval: true defaultPricingPlan: free_unit_kind: free_unit_kind trial_usage_unit: trial_usage_unit usage_unit_kind: usage_unit_kind is_auto_renewable: true installment_schedule: default_installment_amount: 6.519180951018382 overridden_installments: - installment_amount: 4.652396432933246 installment_number: 8.969578798196912 - installment_amount: 4.652396432933246 installment_number: 8.969578798196912 installment_duration: 0.10263654006109402 type: type base_fee: 7.143538047012306 payment_type: payment_type free_units: 7.058770351582356 allow_early_access: true currency: currency billing_duration: 0 trial_usage_limit: 3.0205796992916243 max_fee: 7.740351818741173 usage_unit_price: 3.0576100241049344 updatedOn: updatedOn retiredOn: retiredOn applicationPackageName: applicationPackageName targetAccounts: targetAccounts lastApprovedOn: lastApprovedOn lastPublishedOn: lastPublishedOn lastSubmittedOn: lastSubmittedOn rejectedReason: rejectedReason name: name trialDetails: trial_type: trial_type description: description trial_time_limit: 0.2025324113236393 comment: comment rejectedOn: rejectedOn replicationSchedule: replicationSchedule azureProduct: availabilities: - visibility: visibility enterpriseLicensing: enterpriseLicensing emailAudiences: - description: description id: id - description: description id: id subscriptionAudiences: - description: description id: id - description: description id: id id: id resourceType: resourceType - visibility: visibility enterpriseLicensing: enterpriseLicensing emailAudiences: - description: description id: id - description: description id: id subscriptionAudiences: - description: description id: id - description: description id: id id: id resourceType: resourceType externalIDs: - type: type value: value - type: type value: value variants: - conversionPaths: conversionPaths leadGenID: leadGenID extendedProperties: - type: type value: value - type: type value: value cloudAvailabilities: - cloudAvailabilities - cloudAvailabilities azureGovernmentCertifications: - validationResults: - errorMessage: errorMessage memberNames: - memberNames - memberNames - errorMessage: errorMessage memberNames: - memberNames - memberNames title: title uri: uri - validationResults: - errorMessage: errorMessage memberNames: - memberNames - memberNames - errorMessage: errorMessage memberNames: - memberNames - memberNames title: title uri: uri externalID: externalID referenceVariantID: referenceVariantID id: id state: InActive featureAvailabilities: - markets: - marketCode: marketCode friendlyName: friendlyName - marketCode: marketCode friendlyName: friendlyName visibility: Public priceSchedules: - isBaseSchedule: true schedules: - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true marketCodes: - marketCodes - marketCodes friendlyName: friendlyName - isBaseSchedule: true schedules: - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true marketCodes: - marketCodes - marketCodes friendlyName: friendlyName customMeters: - unitOfMeasure: unitOfMeasure displayName: displayName includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly isEnabled: true priceInUsd: 5.025004791520295 id: id uniqueID: uniqueID - unitOfMeasure: unitOfMeasure displayName: displayName includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly isEnabled: true priceInUsd: 5.025004791520295 id: id uniqueID: uniqueID marketStates: - marketCode: marketCode state: Disabled - marketCode: marketCode state: Disabled tenantAudiences: - description: description id: id - description: description id: id subscriptionAudiences: - description: description id: id - description: description id: id id: id properties: - type: type value: value - type: type value: value trial: duration: 9 dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true type: NoTrial durationType: Minute isHidden: true resourceType: resourceType - markets: - marketCode: marketCode friendlyName: friendlyName - marketCode: marketCode friendlyName: friendlyName visibility: Public priceSchedules: - isBaseSchedule: true schedules: - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true marketCodes: - marketCodes - marketCodes friendlyName: friendlyName - isBaseSchedule: true schedules: - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true marketCodes: - marketCodes - marketCodes friendlyName: friendlyName customMeters: - unitOfMeasure: unitOfMeasure displayName: displayName includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly isEnabled: true priceInUsd: 5.025004791520295 id: id uniqueID: uniqueID - unitOfMeasure: unitOfMeasure displayName: displayName includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly isEnabled: true priceInUsd: 5.025004791520295 id: id uniqueID: uniqueID marketStates: - marketCode: marketCode state: Disabled - marketCode: marketCode state: Disabled tenantAudiences: - description: description id: id - description: description id: id subscriptionAudiences: - description: description id: id - description: description id: id id: id properties: - type: type value: value - type: type value: value trial: duration: 9 dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true type: NoTrial durationType: Minute isHidden: true resourceType: resourceType friendlyName: friendlyName resourceType: AzureSkuVariant - conversionPaths: conversionPaths leadGenID: leadGenID extendedProperties: - type: type value: value - type: type value: value cloudAvailabilities: - cloudAvailabilities - cloudAvailabilities azureGovernmentCertifications: - validationResults: - errorMessage: errorMessage memberNames: - memberNames - memberNames - errorMessage: errorMessage memberNames: - memberNames - memberNames title: title uri: uri - validationResults: - errorMessage: errorMessage memberNames: - memberNames - memberNames - errorMessage: errorMessage memberNames: - memberNames - memberNames title: title uri: uri externalID: externalID referenceVariantID: referenceVariantID id: id state: InActive featureAvailabilities: - markets: - marketCode: marketCode friendlyName: friendlyName - marketCode: marketCode friendlyName: friendlyName visibility: Public priceSchedules: - isBaseSchedule: true schedules: - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true marketCodes: - marketCodes - marketCodes friendlyName: friendlyName - isBaseSchedule: true schedules: - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true marketCodes: - marketCodes - marketCodes friendlyName: friendlyName customMeters: - unitOfMeasure: unitOfMeasure displayName: displayName includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly isEnabled: true priceInUsd: 5.025004791520295 id: id uniqueID: uniqueID - unitOfMeasure: unitOfMeasure displayName: displayName includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly isEnabled: true priceInUsd: 5.025004791520295 id: id uniqueID: uniqueID marketStates: - marketCode: marketCode state: Disabled - marketCode: marketCode state: Disabled tenantAudiences: - description: description id: id - description: description id: id subscriptionAudiences: - description: description id: id - description: description id: id id: id properties: - type: type value: value - type: type value: value trial: duration: 9 dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true type: NoTrial durationType: Minute isHidden: true resourceType: resourceType - markets: - marketCode: marketCode friendlyName: friendlyName - marketCode: marketCode friendlyName: friendlyName visibility: Public priceSchedules: - isBaseSchedule: true schedules: - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true marketCodes: - marketCodes - marketCodes friendlyName: friendlyName - isBaseSchedule: true schedules: - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode - pricingModel: Flat pricingUnits: - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true - unitType: unitType name: sharedcore lowerUnit: 9 upperUnit: 6 isUnlimitedUnit: true priceCadence: type: Month value: 9 retailPrice: openPrice: 8.762042012749001 priceTierID: priceTierID currencyCode: currencyCode dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true marketCodes: - marketCodes - marketCodes friendlyName: friendlyName customMeters: - unitOfMeasure: unitOfMeasure displayName: displayName includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly isEnabled: true priceInUsd: 5.025004791520295 id: id uniqueID: uniqueID - unitOfMeasure: unitOfMeasure displayName: displayName includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly isEnabled: true priceInUsd: 5.025004791520295 id: id uniqueID: uniqueID marketStates: - marketCode: marketCode state: Disabled - marketCode: marketCode state: Disabled tenantAudiences: - description: description id: id - description: description id: id subscriptionAudiences: - description: description id: id - description: description id: id id: id properties: - type: type value: value - type: type value: value trial: duration: 9 dateTimeRange: endAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true startAt: dateTimeInUtc: dateTimeInUtc localizePerMarket: true type: NoTrial durationType: Minute isHidden: true resourceType: resourceType friendlyName: friendlyName resourceType: AzureSkuVariant branches: - module: module id: id variantID: variantID currentDraftInstanceID: currentDraftInstanceID type: type friendlyName: friendlyName resourceType: resourceType - module: module id: id variantID: variantID currentDraftInstanceID: currentDraftInstanceID type: type friendlyName: friendlyName resourceType: resourceType isModularPublishing: true listings: - summary: summary accessInformation: accessInformation keywords: - keywords - keywords compatibleProducts: - compatibleProducts - compatibleProducts description: description shortDescription: shortDescription languageCode: languageCode title: title gettingStartedInstructions: gettingStartedInstructions assets: - fileName: fileName fileSasUri: fileSasUri description: description id: id state: PendingUpload type: type publisherDefinedSasUri: publisherDefinedSasUri friendlyName: friendlyName order: 4 resourceType: ListingAsset - fileName: fileName fileSasUri: fileSasUri description: description id: id state: PendingUpload type: type publisherDefinedSasUri: publisherDefinedSasUri friendlyName: friendlyName order: 4 resourceType: ListingAsset listingUris: - displayText: displayText subtype: subtype type: type uri: uri - displayText: displayText subtype: subtype type: type uri: uri publisherName: publisherName productDisplayName: productDisplayName listingContacts: - phone: phone name: name type: CustomerSupport uri: uri email: email - phone: phone name: name type: CustomerSupport uri: uri email: email id: id resourceType: AzureListing - summary: summary accessInformation: accessInformation keywords: - keywords - keywords compatibleProducts: - compatibleProducts - compatibleProducts description: description shortDescription: shortDescription languageCode: languageCode title: title gettingStartedInstructions: gettingStartedInstructions assets: - fileName: fileName fileSasUri: fileSasUri description: description id: id state: PendingUpload type: type publisherDefinedSasUri: publisherDefinedSasUri friendlyName: friendlyName order: 4 resourceType: ListingAsset - fileName: fileName fileSasUri: fileSasUri description: description id: id state: PendingUpload type: type publisherDefinedSasUri: publisherDefinedSasUri friendlyName: friendlyName order: 4 resourceType: ListingAsset listingUris: - displayText: displayText subtype: subtype type: type uri: uri - displayText: displayText subtype: subtype type: type uri: uri publisherName: publisherName productDisplayName: productDisplayName listingContacts: - phone: phone name: name type: CustomerSupport uri: uri email: email - phone: phone name: name type: CustomerSupport uri: uri email: email id: id resourceType: AzureListing plans: - lifecycleState: notAvailable product: product softwareReservation: paymentSchedule: type: day value: 7.386281948385884 reservationDuration: type: day value: 7.386281948385884 vmPrices: patternProperties: key: quantity: 7.457744773683766 unitPricePerPaymentPeriodInUsd: 1.1730742509559433 $schema: $schema offerPricingType: '{}' visibility: visible planName: planName resourceName: resourceName id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message plan: plan pricing: customMeters: priceInputOption: perMarket meters: '{}' recurrentPrice: recurrentPriceMode: flatRate userLimits: min: 6.84685269835264 max: 1.4894159098541704 priceInputOption: perMarket prices: - billingFrequency: '{}' pricePerPaymentInUsd: 1.2315135367772556 flexibleSchedule: '{}' contractDuration: '{}' billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency - billingFrequency: '{}' pricePerPaymentInUsd: 1.2315135367772556 flexibleSchedule: '{}' contractDuration: '{}' billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency - lifecycleState: notAvailable product: product softwareReservation: paymentSchedule: type: day value: 7.386281948385884 reservationDuration: type: day value: 7.386281948385884 vmPrices: patternProperties: key: quantity: 7.457744773683766 unitPricePerPaymentPeriodInUsd: 1.1730742509559433 $schema: $schema offerPricingType: '{}' visibility: visible planName: planName resourceName: resourceName id: id validations: - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message - resourceId: resourceId code: businessValidationError $schema: $schema level: informational message: message plan: plan pricing: customMeters: priceInputOption: perMarket meters: '{}' recurrentPrice: recurrentPriceMode: flatRate userLimits: min: 6.84685269835264 max: 1.4894159098541704 priceInputOption: perMarket prices: - billingFrequency: '{}' pricePerPaymentInUsd: 1.2315135367772556 flexibleSchedule: '{}' contractDuration: '{}' billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency - billingFrequency: '{}' pricePerPaymentInUsd: 1.2315135367772556 flexibleSchedule: '{}' contractDuration: '{}' billingTerm: type: day value: 7.386281948385884 paymentOption: type: day value: 7.386281948385884 prices: - markets: - markets - markets price: 1.0246457001441578 currency: currency - markets: - markets - markets price: 1.0246457001441578 currency: currency submissions: - subState: InDraft pendingUpdateInfo: status: status updateType: updateType resources: - type: type value: value - type: type value: value areResourcesReady: true id: id publishedTimeInUtc: 2000-01-23 04:56:07+00:00 state: Inprogress variantResources: - resources: - type: type value: value - type: type value: value variantID: variantID - resources: - type: type value: value - type: type value: value variantID: variantID releaseNumber: 4 targets: - type: type value: value - type: type value: value friendlyName: friendlyName resourceType: Submission - subState: InDraft pendingUpdateInfo: status: status updateType: updateType resources: - type: type value: value - type: type value: value areResourcesReady: true id: id publishedTimeInUtc: 2000-01-23 04:56:07+00:00 state: Inprogress variantResources: - resources: - type: type value: value - type: type value: value variantID: variantID - resources: - type: type value: value - type: type value: value variantID: variantID releaseNumber: 4 targets: - type: type value: value - type: type value: value friendlyName: friendlyName resourceType: Submission name: name packageConfigurations: - landingPageUri: landingPageUri azureActiveDirectoryApplicationID: azureActiveDirectoryApplicationID id: id azureActiveDirectoryTenantID: azureActiveDirectoryTenantID connectionWebhook: connectionWebhook resourceType: AzureSoftwareAsAServicePackageConfiguration - landingPageUri: landingPageUri azureActiveDirectoryApplicationID: azureActiveDirectoryApplicationID id: id azureActiveDirectoryTenantID: azureActiveDirectoryTenantID connectionWebhook: connectionWebhook resourceType: AzureSoftwareAsAServicePackageConfiguration setup: '{}' id: id properties: - appVersion: appVersion useEnterpriseContract: true submissionVersion: submissionVersion customAmendments: - customAmendments - customAmendments extendedProperties: - extendedProperties - extendedProperties termsOfUse: termsOfUse hideKeys: - hideKeys - hideKeys leveledIndustries: key: '' marketingOnlyChange: true globalAmendmentTerms: globalAmendmentTerms industries: - industries - industries additionalCategories: - additionalCategories - additionalCategories applicableProducts: - applicableProducts - applicableProducts leveledCategories: key: '' categories: - categories - categories id: id productTags: - productTags - productTags resourceType: resourceType - appVersion: appVersion useEnterpriseContract: true submissionVersion: submissionVersion customAmendments: - customAmendments - customAmendments extendedProperties: - extendedProperties - extendedProperties termsOfUse: termsOfUse hideKeys: - hideKeys - hideKeys leveledIndustries: key: '' marketingOnlyChange: true globalAmendmentTerms: globalAmendmentTerms industries: - industries - industries additionalCategories: - additionalCategories - additionalCategories applicableProducts: - applicableProducts - applicableProducts leveledCategories: key: '' categories: - categories - categories id: id productTags: - productTags - productTags resourceType: resourceType resourceType: resourceType gcpProduct: revisionId: revisionId marketplace: marketplaces/google-cloud serviceConfig: name: name producerProjectId: producerProjectId metrics: - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 displayUnitDescription: displayUnitDescription unit: unit metricKind: metricKind displayName: displayName valueType: '{}' name: name description: description displayUnit: displayUnit id: id reportingUnit: reportingUnit skuId: skuId - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 displayUnitDescription: displayUnitDescription unit: unit metricKind: metricKind displayName: displayName valueType: '{}' name: name description: description displayUnit: displayUnit id: id reportingUnit: reportingUnit skuId: skuId title: title billing: metrics: - metrics - metrics createTime: 2000-01-23 04:56:07+00:00 service: service listingSpec: marketingSpec: signupUri: signupUri externalLicenseSpecs: - description: description uri: uri - description: description uri: uri searchKeywords: - searchKeywords - searchKeywords tagLine: tagLine displayNames: - displayNames - displayNames externalMarketingUrl: externalMarketingUrl icon: icon description: description searchCategories: - searchCategories - searchCategories searchDescription: searchDescription title: title supportSpec: description: description uri: uri email: email eulaUrl: eulaUrl documentationSpecs: - description: description title: title uri: uri - description: description title: title uri: uri purchaseSpec: features: - name: name description: description title: title - name: name description: description title: title purchaseOptionSpecs: - priceInfo: usageFees: - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 subscriptionPlans: - period: period price: nanos: 1 units: units currencyCode: currencyCode - period: period price: nanos: 1 units: units currencyCode: currencyCode description: description priceModel: FREE purchaseMode: PURCHASE_MODE_PRIVATE name: name title: title featureValues: - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription - priceInfo: usageFees: - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 metricId: metricId displayQuantity: 5 subscriptionPlans: - period: period price: nanos: 1 units: units currencyCode: currencyCode - period: period price: nanos: 1 units: units currencyCode: currencyCode description: description priceModel: FREE purchaseMode: PURCHASE_MODE_PRIVATE name: name title: title featureValues: - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription - featureValue: featureValue featureTitle: featureTitle featureName: featureName featureDescription: featureDescription metrics: - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 displayUnitDescription: displayUnitDescription unit: unit metricKind: metricKind displayName: displayName valueType: '{}' name: name description: description displayUnit: displayUnit id: id reportingUnit: reportingUnit skuId: skuId - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 displayUnitDescription: displayUnitDescription unit: unit metricKind: metricKind displayName: displayName valueType: '{}' name: name description: description displayUnit: displayUnit id: id reportingUnit: reportingUnit skuId: skuId listingType: BillingIntegratedManagedService termsSpec: standardEula: '{}' inlineEula: '{}' eulaUri: eulaUri externalAccountSpec: signupUri: signupUri loginUri: loginUri singleSignOnUri: singleSignOnUri name: name validationSummary: '{}' lastPublishTime: 2000-01-23 04:56:07+00:00 derivedDiscoveryState: accessState: ALLUSERS_ACCESSIBLE searchState: ADMIN_OVERRIDE_UNSEARCHABLE id: id revisionCreateTime: 2000-01-23 04:56:07+00:00 refundCancellationPolicy: refundCancellationPolicy awsProfessionalServicesProduct: Repositories: - Type: Type Url: Url - Type: Type Url: Url Description: UsW9Submitted: true Highlights: - Highlights - Highlights Categories: - Categories - Categories ProductCode: ProductCode SearchKeywords: - SearchKeywords - SearchKeywords ProductTitle: ProductTitle EuW8Submitted: true ShortDescription: ShortDescription LongDescription: LongDescription Manufacturer: Manufacturer Visibility: Limited AssociatedProducts: '{}' Sku: Sku Registered: true Versions: - CreationDate: 2000-01-23 04:56:07+00:00 Id: Id DeliveryOptions: - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription ReleaseNotes: ReleaseNotes VersionTitle: VersionTitle - CreationDate: 2000-01-23 04:56:07+00:00 Id: Id DeliveryOptions: - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription ReleaseNotes: ReleaseNotes VersionTitle: VersionTitle productId: productId PromotionalResources: AdditionalResources: - Type: Type Text: Text Url: Url - Type: Type Text: Text Url: Url LogoUrl: LogoUrl Videos: - Type: Type Title: Title Url: Url - Type: Type Title: Title Url: Url dataFeedProductId: dataFeedProductId Dimensions: - Types: - Types - Types Description: Description Length: 2 Rate: 6.778324963048013 TimeUnit: DAY Unit: Unit Key: Key Name: Name - Types: - Types - Types Description: Description Length: 2 Rate: 6.778324963048013 TimeUnit: DAY Unit: Unit Key: Key Name: Name SignatureVerificationKeys: - Status: Status PublicKey: PublicKey PublicKeyVersion: 2 - Status: Status PublicKey: PublicKey PublicKeyVersion: 2 SupportInformation: Description: Description commits: - types: - types - types quantity: 4 length: 9 description: description type: '{}' maximumUsers: 361608 rate: 7.386281948385884 isUserCreated: true minimumUsers: 202713 name: name term: term category: category termEndTime: termEndTime key: key timeUnit: '{}' - types: - types - types quantity: 4 length: 9 description: description type: '{}' maximumUsers: 361608 rate: 7.386281948385884 isUserCreated: true minimumUsers: 202713 name: name term: term category: category termEndTime: termEndTime key: key timeUnit: '{}' attributes: key: attributes currency: currency awsMachineLearningProduct: Repositories: - Type: Type Url: Url - Type: Type Url: Url Description: UsW9Submitted: true Highlights: - Highlights - Highlights Categories: - Categories - Categories ProductCode: ProductCode SearchKeywords: - SearchKeywords - SearchKeywords ProductTitle: ProductTitle EuW8Submitted: true ShortDescription: ShortDescription LongDescription: LongDescription Manufacturer: Manufacturer Visibility: Limited AssociatedProducts: '{}' Sku: Sku Registered: true Versions: - CreationDate: 2000-01-23 04:56:07+00:00 Id: Id DeliveryOptions: - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription ReleaseNotes: ReleaseNotes VersionTitle: VersionTitle - CreationDate: 2000-01-23 04:56:07+00:00 Id: Id DeliveryOptions: - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription - Recommendations: '{}' Type: Type AmiAlias: AmiAlias SourceId: SourceId Title: Title Visibility: Visibility FulfillmentUrl: FulfillmentUrl Id: Id ShortDescription: ShortDescription ReleaseNotes: ReleaseNotes VersionTitle: VersionTitle productId: productId PromotionalResources: AdditionalResources: - Type: Type Text: Text Url: Url - Type: Type Text: Text Url: Url LogoUrl: LogoUrl Videos: - Type: Type Title: Title Url: Url - Type: Type Title: Title Url: Url dataFeedProductId: dataFeedProductId Dimensions: - Types: - Types - Types Description: Description Length: 2 Rate: 6.778324963048013 TimeUnit: DAY Unit: Unit Key: Key Name: Name - Types: - Types - Types Description: Description Length: 2 Rate: 6.778324963048013 TimeUnit: DAY Unit: Unit Key: Key Name: Name SignatureVerificationKeys: - Status: Status PublicKey: PublicKey PublicKeyVersion: 2 - Status: Status PublicKey: PublicKey PublicKeyVersion: 2 SupportInformation: Description: Description stripeProduct: images: - images - images metadata: key: metadata livemode: true created: 6 active: true description: description url: url package_dimensions: '{}' statement_descriptor: statement_descriptor marketing_features: - name: name - name: name tax_code: '{}' shippable: true name: name id: id unit_label: unit_label updated: 4 object: object dimensions: - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 types: - types - types description: description planName: planName usageCount: '{}' rate: 6.84685269835264 includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly valueType: '{}' name: name planId: planId category: category key: key skuId: skuId - priceTiers: - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 - startingUsageAmount: startingUsageAmount price: nanos: 1 units: units currencyCode: currencyCode fromAmount: 1.0246457001441578 types: - types - types description: description planName: planName usageCount: '{}' rate: 6.84685269835264 includedBaseQuantities: - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly - quantity: 1.2315135367772556 isInfinite: true recurringUnit: Monthly valueType: '{}' name: name planId: planId category: category key: key skuId: skuId lastUpdateTime: 2000-01-23 04:56:07+00:00 status: status properties: createdBy: type: string creationTime: format: date-time type: string externalID: type: string fulfillmentUrl: type: string id: type: string info: $ref: '#/components/schemas/ProductInfo' lastUpdateTime: format: date-time type: string lastUpdatedBy: type: string metaInfo: $ref: '#/components/schemas/WorkloadMetaInfo' name: type: string organizationID: type: string partner: $ref: '#/components/schemas/Partner' partnerID: type: string productType: enum: - UNKNOWN - SUBSCRIPTION - CONTRACT - FLAT_RATE - PER_USER - USAGE_BASED type: string service: $ref: '#/components/schemas/PartnerService' status: type: string type: object client.DescribeInstanceResponseBody: example: Status: Status ProductName: ProductName EndOn: 5 InstanceId: 2 ProductCode: ProductCode Modules: Module: - Id: Id Properties: Property: - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark DisplayUnit: DisplayUnit Key: Key Name: Name ShowType: ShowType - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark DisplayUnit: DisplayUnit Key: Key Name: Name ShowType: ShowType Code: Code Name: Name - Id: Id Properties: Property: - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark DisplayUnit: DisplayUnit Key: Key Name: Name ShowType: ShowType - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark DisplayUnit: DisplayUnit Key: Key Name: Name ShowType: ShowType Code: Code Name: Name RelationalData: ServiceStatus: ServiceStatus AppJson: AppJson ProductType: ProductType OrderId: 7 Constraints: Constraints AutoRenewal: AutoRenewal ExtendJson: ExtendJson ComponentJson: ComponentJson IsTrial: true SupplierName: SupplierName ProductSkuCode: ProductSkuCode CreatedOn: 5 HostJson: HostJson BeganOn: 1 properties: AppJson: type: string AutoRenewal: type: string BeganOn: type: integer ComponentJson: type: string Constraints: type: string CreatedOn: type: integer EndOn: type: integer ExtendJson: type: string HostJson: type: string InstanceId: type: integer IsTrial: type: boolean Modules: $ref: '#/components/schemas/client.DescribeInstanceResponseBodyModules' OrderId: type: integer ProductCode: type: string ProductName: type: string ProductSkuCode: type: string ProductType: type: string RelationalData: $ref: '#/components/schemas/client.DescribeInstanceResponseBodyRelationalData' Status: type: string SupplierName: type: string type: object client.DescribeInstanceResponseBodyModules: example: Module: - Id: Id Properties: Property: - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark DisplayUnit: DisplayUnit Key: Key Name: Name ShowType: ShowType - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark DisplayUnit: DisplayUnit Key: Key Name: Name ShowType: ShowType Code: Code Name: Name - Id: Id Properties: Property: - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark DisplayUnit: DisplayUnit Key: Key Name: Name ShowType: ShowType - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark DisplayUnit: DisplayUnit Key: Key Name: Name ShowType: ShowType Code: Code Name: Name properties: Module: items: $ref: '#/components/schemas/client.DescribeInstanceResponseBodyModulesModule' type: array type: object client.DescribeInstanceResponseBodyModulesModule: example: Id: Id Properties: Property: - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark DisplayUnit: DisplayUnit Key: Key Name: Name ShowType: ShowType - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark DisplayUnit: DisplayUnit Key: Key Name: Name ShowType: ShowType Code: Code Name: Name properties: Code: type: string Id: type: string Name: type: string Properties: $ref: '#/components/schemas/client.DescribeInstanceResponseBodyModulesModuleProperties' type: object client.DescribeInstanceResponseBodyModulesModuleProperties: example: Property: - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark DisplayUnit: DisplayUnit Key: Key Name: Name ShowType: ShowType - PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark DisplayUnit: DisplayUnit Key: Key Name: Name ShowType: ShowType properties: Property: items: $ref: '#/components/schemas/client.DescribeInstanceResponseBodyModulesModulePropertiesProperty' type: array type: object client.DescribeInstanceResponseBodyModulesModulePropertiesProperty: example: PropertyValues: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark DisplayUnit: DisplayUnit Key: Key Name: Name ShowType: ShowType properties: DisplayUnit: type: string Key: type: string Name: type: string PropertyValues: $ref: '#/components/schemas/client.DescribeInstanceResponseBodyModulesModulePropertiesPropertyPropertyValues' ShowType: type: string type: object client.DescribeInstanceResponseBodyModulesModulePropertiesPropertyPropertyValues: example: PropertyValue: - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark - Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark properties: PropertyValue: items: $ref: '#/components/schemas/client.DescribeInstanceResponseBodyModulesModulePropertiesPropertyPropertyValuesPropertyValue' type: array type: object client.DescribeInstanceResponseBodyModulesModulePropertiesPropertyPropertyValuesPropertyValue: example: Type: Type Min: Min Max: Max DisplayName: DisplayName Value: Value Step: Step Remark: Remark properties: DisplayName: type: string Max: type: string Min: type: string Remark: type: string Step: type: string Type: type: string Value: type: string type: object client.DescribeInstanceResponseBodyRelationalData: example: ServiceStatus: ServiceStatus properties: ServiceStatus: type: string type: object client.DescribeOrderResponseBody: example: PaidOn: 1 CouponPrice: 2.027123023002322 PeriodType: PeriodType OriginalPrice: 1.2315135367772556 PayStatus: PayStatus ProductName: ProductName RequestId: RequestId ProductCode: ProductCode SupplierCompanyName: SupplierCompanyName Quantity: 6 OrderId: 7 SupplierTelephones: Telephone: - Telephone - Telephone Components: key: '' OrderStatus: OrderStatus OrderType: OrderType TotalPrice: 7.457744773683766 ProductSkuCode: ProductSkuCode CreatedOn: 4 PaymentPrice: 1.4894159098541704 InstanceIds: InstanceId: - InstanceId - InstanceId AccountQuantity: 9 AliUid: 3 properties: AccountQuantity: type: integer AliUid: type: integer Components: additionalProperties: true type: object CouponPrice: type: number CreatedOn: type: integer InstanceIds: $ref: '#/components/schemas/client.DescribeOrderResponseBodyInstanceIds' OrderId: type: integer OrderStatus: type: string OrderType: type: string OriginalPrice: type: number PaidOn: type: integer PayStatus: type: string PaymentPrice: type: number PeriodType: type: string ProductCode: type: string ProductName: type: string ProductSkuCode: type: string Quantity: type: integer RequestId: type: string SupplierCompanyName: type: string SupplierTelephones: $ref: '#/components/schemas/client.DescribeOrderResponseBodySupplierTelephones' TotalPrice: type: number type: object client.DescribeOrderResponseBodyInstanceIds: example: InstanceId: - InstanceId - InstanceId properties: InstanceId: items: type: string type: array type: object client.DescribeOrderResponseBodySupplierTelephones: example: Telephone: - Telephone - Telephone properties: Telephone: items: type: string type: array type: object client.PushMeteringDataRequest: properties: Metering: type: string type: object client.PushMeteringDataResponseBody: properties: RequestId: type: string Success: type: boolean type: object database_sql.NullTime: example: valid: true time: time properties: time: type: string valid: description: Valid is true if Time is not NULL type: boolean type: object github_com_aws_aws-sdk-go-v2_service_marketplacemetering_types.Tag: properties: key: description: 'One part of a key-value pair that makes up a tag . A key is a label that acts like a category for the specific tag values. This member is required.' type: string value: description: 'One part of a key-value pair that makes up a tag . A value acts as a descriptor within a tag category (key). The value can be empty or null. This member is required.' type: string type: object github_com_sugerio_marketplace-service_pkg_legacy_rds-db_lib.BillingAwsBillingEvent: example: brokerID: brokerID usagePeriodStartDate: valid: true time: time productID: productID insertDate: valid: true time: time toAccountID: toAccountID usagePeriodEndDate: valid: true time: time parentBillingEventID: parentBillingEventID disbursementBillingEventID: disbursementBillingEventID action: action offerID: offerID currency: currency invoiceID: invoiceID id: id balanceImpacting: 5 amount: 5.962133916683182 endUserAccountID: endUserAccountID dataFeedProductID: dataFeedProductID entitlementID: entitlementID buyerID: buyerID invoiceDate: valid: true time: time transactionReferenceID: transactionReferenceID organizationID: organizationID transactionType: transactionType paymentDueDate: valid: true time: time fromAccountID: fromAccountID agreementID: agreementID billingAddressID: billingAddressID bankTraceID: bankTraceID properties: action: type: string agreementID: type: string amount: type: number balanceImpacting: type: integer bankTraceID: type: string billingAddressID: type: string brokerID: type: string buyerID: type: string currency: type: string dataFeedProductID: type: string disbursementBillingEventID: type: string endUserAccountID: type: string entitlementID: type: string fromAccountID: type: string id: type: string insertDate: $ref: '#/components/schemas/database_sql.NullTime' invoiceDate: $ref: '#/components/schemas/database_sql.NullTime' invoiceID: type: string offerID: type: string organizationID: type: string parentBillingEventID: type: string paymentDueDate: $ref: '#/components/schemas/database_sql.NullTime' productID: type: string toAccountID: type: string transactionReferenceID: type: string transactionType: type: string usagePeriodEndDate: $ref: '#/components/schemas/database_sql.NullTime' usagePeriodStartDate: $ref: '#/components/schemas/database_sql.NullTime' type: object github_com_sugerio_marketplace-service_pkg_legacy_rds-db_lib.BillingAzureCmaRevenue: example: purchaseRecordID: purchaseRecordID productID: productID termEndDate: termEndDate azureCustomerID: azureCustomerID billingModel: billingModel payoutStatus: payoutStatus resellerCity: resellerCity resellerID: resellerID programName: programName resellerState: resellerState azureAssetID: azureAssetID offerID: offerID earningUsd: 2.3021358869347655 invoiceID: invoiceID azurePlanID: azurePlanID paymentStatus: paymentStatus revenueUsd: 7.061401241503109 azureBillingAccountID: azureBillingAccountID entitlementID: entitlementID resellerEmail: resellerEmail buyerID: buyerID invoiceDate: valid: true time: time transactionDate: valid: true time: time earningID: earningID invoiceDueDate: valid: true time: time resellerCompany: resellerCompany organizationID: organizationID resellerCountry: resellerCountry paymentID: paymentID termStartDate: termStartDate azureOfferID: azureOfferID estimatedPayoutMonth: valid: true time: time paymentSentDate: valid: true time: time properties: azureAssetID: type: string azureBillingAccountID: type: string azureCustomerID: type: string azureOfferID: type: string azurePlanID: type: string billingModel: type: string buyerID: type: string earningID: type: string earningUsd: type: number entitlementID: type: string estimatedPayoutMonth: $ref: '#/components/schemas/database_sql.NullTime' invoiceDate: $ref: '#/components/schemas/database_sql.NullTime' invoiceDueDate: $ref: '#/components/schemas/database_sql.NullTime' invoiceID: type: string offerID: type: string organizationID: type: string paymentID: type: string paymentSentDate: $ref: '#/components/schemas/database_sql.NullTime' paymentStatus: type: string payoutStatus: type: string productID: type: string programName: type: string purchaseRecordID: type: string resellerCity: type: string resellerCompany: type: string resellerCountry: type: string resellerEmail: type: string resellerID: type: string resellerState: type: string revenueUsd: type: number termEndDate: type: string termStartDate: type: string transactionDate: $ref: '#/components/schemas/database_sql.NullTime' type: object github_com_sugerio_marketplace-service_pkg_legacy_rds-db_lib.BillingGcpChargeUsage: example: productID: productID usage: 1.1730742509559433 withheld: 4.965218492984954 paymentType: paymentType accountID: accountID refundBalanceOutstanding: 1.4894159098541704 reportDate: reportDate trialUse: 7.457744773683766 paymentSchedule: paymentSchedule offerID: offerID currency: currency prepayCredits: 1.2315135367772556 abandoned: 3.616076749251911 sku: sku released: 6.84685269835264 usedBy: usedBy insightAccountID: insightAccountID dueVendor: 4.145608029883936 resource: resource googleEntity: googleEntity refundReason: refundReason entitlementID: entitlementID buyerID: buyerID organizationID: organizationID charges: 2.027123023002322 unit: unit refundBalanceDeductedThisMonth: 1.0246457001441578 ordinal: 7 properties: abandoned: type: number accountID: type: string buyerID: type: string charges: type: number currency: type: string dueVendor: type: number entitlementID: type: string googleEntity: type: string insightAccountID: type: string offerID: type: string ordinal: type: integer organizationID: type: string paymentSchedule: type: string paymentType: type: string prepayCredits: type: number productID: type: string refundBalanceDeductedThisMonth: type: number refundBalanceOutstanding: type: number refundReason: type: string released: type: number reportDate: type: string resource: type: string sku: type: string trialUse: type: number unit: type: string usage: type: number usedBy: type: string withheld: type: number type: object github_com_sugerio_marketplace-service_pkg_legacy_rds-db_lib.IdentityApiClient: example: organizationID: organizationID role: role apiKeyHash: apiKeyHash creationTime: creationTime provider: provider id: id secret: secret type: type info: - 0 - 0 lastUpdateTime: lastUpdateTime properties: apiKeyHash: type: string creationTime: type: string id: type: string info: items: type: integer type: array lastUpdateTime: type: string organizationID: type: string provider: type: string role: type: string secret: type: string type: type: string type: object github_com_sugerio_marketplace-service_pkg_legacy_rds-db_lib.UpdateEntitlementNameParams: properties: id: type: string name: type: string organizationID: type: string type: object github_com_sugerio_marketplace-service_third_party_azure_sdk_marketplacemeteringv1.BatchUsageEventOkResponse: properties: count: type: integer result: items: $ref: '#/components/schemas/github_com_sugerio_marketplace-service_third_party_azure_sdk_marketplacemeteringv1.UsageBatchEventOkMessage' type: array type: object github_com_sugerio_marketplace-service_third_party_azure_sdk_marketplacemeteringv1.UsageBatchEventOkMessage: properties: dimension: description: Dimension identifier type: string effectiveStartTime: description: Time in UTC when the usage event occurred type: string error: $ref: '#/components/schemas/github_com_sugerio_marketplace-service_third_party_azure_sdk_marketplacemeteringv1.UsageEventConflictResponse' messageTime: description: Time this message was created in UTC type: string planId: description: Plan associated with the purchased offer type: string quantity: description: Number of units consumed type: number resourceId: description: Identifier of the resource against which usage is emitted type: string resourceUri: description: Identifier of the managed app resource against which usage is emitted type: string status: allOf: - $ref: '#/components/schemas/github_com_sugerio_marketplace-service_third_party_azure_sdk_marketplacemeteringv1.UsageEventStatusEnum' description: Status of the operation. type: object usageEventId: description: Unique identifier associated with the usage event type: string type: object github_com_sugerio_marketplace-service_third_party_azure_sdk_marketplacemeteringv1.UsageEventConflictResponse: properties: additionalInfo: $ref: '#/components/schemas/github_com_sugerio_marketplace-service_third_party_azure_sdk_marketplacemeteringv1.UsageEventConflictResponseAdditionalInfo' code: type: string message: type: string type: object ? github_com_sugerio_marketplace-service_third_party_azure_sdk_marketplacemeteringv1.UsageEventConflictResponseAdditionalInfo : properties: acceptedMessage: $ref: '#/components/schemas/github_com_sugerio_marketplace-service_third_party_azure_sdk_marketplacemeteringv1.UsageEventOkResponse' type: object github_com_sugerio_marketplace-service_third_party_azure_sdk_marketplacemeteringv1.UsageEventOkResponse: properties: dimension: description: Dimension identifier type: string effectiveStartTime: description: Time in UTC when the usage event occurred type: string messageTime: description: Time this message was created in UTC type: string planId: description: Plan associated with the purchased offer type: string quantity: description: Number of units consumed type: number resourceId: description: Identifier of the resource against which usage is emitted type: string resourceUri: description: Identifier of the managed app resource against which usage is emitted type: string status: allOf: - $ref: '#/components/schemas/github_com_sugerio_marketplace-service_third_party_azure_sdk_marketplacemeteringv1.UsageEventStatusEnum' description: Status of the operation. type: object usageEventId: description: Unique identifier associated with the usage event type: string type: object github_com_sugerio_marketplace-service_third_party_azure_sdk_marketplacemeteringv1.UsageEventStatusEnum: enum: - Accepted - Expired - Duplicate - Error - ResourceNotFound - ResourceNotAuthorized - InvalidDimension - InvalidQuantity - BadArgument type: string x-enum-varnames: - UsageEventStatusEnumAccepted - UsageEventStatusEnumExpired - UsageEventStatusEnumDuplicate - UsageEventStatusEnumError - UsageEventStatusEnumResourceNotFound - UsageEventStatusEnumResourceNotAuthorized - UsageEventStatusEnumInvalidDimension - UsageEventStatusEnumInvalidQuantity - UsageEventStatusEnumBadArgument marketplacemetering.BatchMeterUsageOutput: properties: resultMetadata: allOf: - $ref: '#/components/schemas/middleware.Metadata' description: Metadata pertaining to the operation's result. type: object results: description: 'Contains all UsageRecords processed by BatchMeterUsage . These records were either honored by AWS Marketplace Metering Service or were invalid. Invalid records should be fixed before being resubmitted.' items: $ref: '#/components/schemas/types.UsageRecordResult' type: array unprocessedRecords: description: 'Contains all UsageRecords that were not processed by BatchMeterUsage . This is a list of UsageRecords . You can retry the failed request by making another BatchMeterUsage call with this list as input in the BatchMeterUsageRequest .' items: $ref: '#/components/schemas/types.UsageRecord' type: array type: object middleware.Metadata: type: object servicecontrol.ReportError: properties: operationId: description: 'OperationId: The Operation.operation_id value from the request.' type: string status: allOf: - $ref: '#/components/schemas/servicecontrol.Status' description: 'Status: Details of the error when processing the Operation.' type: object type: object servicecontrol.ReportResponse: properties: reportErrors: description: 'ReportErrors: Partial failures, one for each `Operation` in the request that failed processing. There are three possible combinations of the RPC status: 1. The combination of a successful RPC status and an empty `report_errors` list indicates a complete success where all `Operations` in the request are processed successfully. 2. The combination of a successful RPC status and a non-empty `report_errors` list indicates a partial success where some `Operations` in the request succeeded. Each `Operation` that failed processing has a corresponding item in this list. 3. A failed RPC status indicates a general non-deterministic failure. When this happens, it''s impossible to know which of the ''Operations'' in the request succeeded or failed.' items: $ref: '#/components/schemas/servicecontrol.ReportError' type: array serviceConfigId: description: 'ServiceConfigId: The actual config id used to process the request.' type: string serviceRolloutId: description: 'ServiceRolloutId: The current service rollout id used to process the request.' type: string type: object servicecontrol.Status: properties: code: description: 'Code: The status code, which should be an enum value of google.rpc.Code.' type: integer details: description: 'Details: A list of messages that carry the error details. There is a common set of message types for APIs to use.' items: items: type: integer type: array type: array message: description: 'Message: 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 field, or localized by the client.' type: string type: object types.Entitlement: example: productCode: productCode customerIdentifier: customerIdentifier dimension: dimension value: '{}' expirationDate: expirationDate properties: customerIdentifier: description: 'The customer identifier is a handle to each unique customer in an application. Customer identifiers are obtained through the ResolveCustomer operation in AWS Marketplace Metering Service.' type: string dimension: description: 'The dimension for which the given entitlement applies. Dimensions represent categories of capacity in a product and are specified when the product is listed in AWS Marketplace.' type: string expirationDate: description: 'The expiration date represents the minimum date through which this entitlement is expected to remain valid. For contractual products listed on AWS Marketplace, the expiration date is the date at which the customer will renew or cancel their contract. Customers who are opting to renew their contract will still have entitlements with an expiration date.' type: string productCode: description: 'The product code for which the given entitlement applies. Product codes are provided by AWS Marketplace when the product listing is created.' type: string value: allOf: - $ref: '#/components/schemas/types.EntitlementValue' description: 'The EntitlementValue represents the amount of capacity that the customer is entitled to for the product.' type: object type: object types.EntitlementValue: properties: booleanValue: description: 'The BooleanValue field will be populated with a boolean value when the entitlement is a boolean type. Otherwise, the field will not be set.' type: boolean doubleValue: description: 'The DoubleValue field will be populated with a double value when the entitlement is a double type. Otherwise, the field will not be set.' type: number integerValue: description: 'The IntegerValue field will be populated with an integer value when the entitlement is an integer type. Otherwise, the field will not be set.' type: integer stringValue: description: 'The StringValue field will be populated with a string value when the entitlement is a string type. Otherwise, the field will not be set.' type: string type: object types.UsageAllocation: properties: allocatedUsageQuantity: description: 'The total quantity allocated to this bucket of usage. This member is required.' type: integer tags: description: 'The set of tags that define the bucket of usage. For the bucket of items with no tags, this parameter can be left out.' items: $ref: '#/components/schemas/github_com_aws_aws-sdk-go-v2_service_marketplacemetering_types.Tag' type: array type: object types.UsageRecord: properties: customerIdentifier: description: 'The CustomerIdentifier is obtained through the ResolveCustomer operation and represents an individual buyer in your application. This member is required.' type: string dimension: description: 'During the process of registering a product on AWS Marketplace, dimensions are specified. These represent different units of value in your application. This member is required.' type: string quantity: description: 'The quantity of usage consumed by the customer for the given dimension and time. Defaults to 0 if not specified.' type: integer timestamp: description: 'Timestamp, in UTC, for which the usage is being reported. Your application can meter usage for up to one hour in the past. Make sure the timestamp value is not before the start of the software usage. This member is required.' type: string usageAllocations: description: 'The set of UsageAllocations to submit. The sum of all UsageAllocation quantities must equal the Quantity of the UsageRecord .' items: $ref: '#/components/schemas/types.UsageAllocation' type: array type: object types.UsageRecordResult: properties: meteringRecordId: description: The MeteringRecordId is a unique identifier for this metering event. type: string status: allOf: - $ref: '#/components/schemas/types.UsageRecordResultStatus' description: "The UsageRecordResult Status indicates the status of an individual\ \ UsageRecord\nprocessed by BatchMeterUsage .\n - Success- The UsageRecord\ \ was accepted and honored by BatchMeterUsage .\n - CustomerNotSubscribed-\ \ The CustomerIdentifier specified is not able to use\n your product.\ \ The UsageRecord was not honored. There are three causes for this\n \ \ result:\n - The customer identifier is invalid.\n - The customer identifier\ \ provided in the metering record does not have an\n active agreement\ \ or subscription with this product. Future UsageRecords for\n this customer\ \ will fail until the customer subscribes to your product.\n - The customer's\ \ AWS account was suspended.\n - DuplicateRecord- Indicates that the\ \ UsageRecord was invalid and not honored.\n A previously metered UsageRecord\ \ had the same customer, dimension, and time,\n but a different quantity." type: object usageRecord: allOf: - $ref: '#/components/schemas/types.UsageRecord' description: The UsageRecord that was part of the BatchMeterUsage request. type: object type: object types.UsageRecordResultStatus: enum: - Success - CustomerNotSubscribed - DuplicateRecord type: string x-enum-varnames: - UsageRecordResultStatusSuccess - UsageRecordResultStatusCustomerNotSubscribed - UsageRecordResultStatusDuplicateRecord CreateSupportTicketAttachment_request: properties: file: description: File to upload format: binary type: string required: - file type: object securitySchemes: APIKeyAuth: description: API Key for authorization in format of . in: header name: Authorization type: apiKey x-original-swagger-version: '2.0'