createUsageReaderWithFieldDefinitions is in Preview status and is subject to change without notice. For more information about Preview status, see the GraphQL API policy.


Create Usage Reader only with field definitions

This page contains

    Authorization Rules

    This request requires authorization with at least one of the following scopes:






    input CreateUsageReaderWithFieldDefinitionsInput! PREVIEW

    Input to create usage reader only with field definitions

    CreateUsageReaderWithFieldDefinitionsInput fields

    name String!

    Name for usage reader

    vendorId String!

    Unique ID for vendor of the product

    productId String!

    Unique ID of the product

    usageProcessingType UsageProcessingType! PREVIEW

    Processing Type of usage

    billable Boolean

    If true, usage associating with this reader are billable

    parser CreateUsageEventParserInput! PREVIEW

    Usage reader specific Parsing information

    fieldDefinitions [CreateUsageReaderFieldDefinitionsInput!] PREVIEW

    List of fields which are part of usage event. eg. accountId, quantity, unitPrice, etc

    createdBy String

    Email Id of author while creating the usage reader fields

    updatedBy String

    Email Id of author while updating the usage reader fields

    Return Fields

    readerId ID!

    Unique identifier of new usage reader

    userErrors [CreateUsageReaderWithFieldDefinitionsErrors!] PREVIEW

    Interactive example

    This is an example mutation query. Use the embedded interactive tool below to edit the query.

    Hint: use Ctrl + Space for autocompleting fields.