Skip to main content

GetGroupBilling​

Returns billing information for the given group over the given query time span.

Path Parameters
  • group_id string required

    Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

    A universally unique identifier.

Query Parameters
  • query_start int64

    Unsigned 64 bit integer.

  • query_end int64

    Unsigned 64 bit integer.

Responses

GetGroupBilling 200 response

Schema
  • billing object required

    A group billing summary.

    • games object[] required

      A list of multiple game lobby expenses.

      • game object required

        A game handle.

        • game_id string required

          Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

          A universally unique identifier.

        • name_id string required

          Possible values: 1 ≤ length ≤ 16, Value must match regular expression ^[a-zA-Z0-9](?:[a-zA-Z0-9]-?)+[a-zA-Z0-9]$

          A human readable short identifier used to references resources.

          Different than a rivet.common#Uuid because this is intended to be human readable.

          Different than rivet.common#DisplayName because this should not include special characters and be short.

        • display_name string required

          Possible values: 1 ≤ length ≤ 24, Value must match regular expression ^(?:[^ \n\r] ?)+[^ \n\r]$

          Represent a resource's readable display name.

        • logo_url string

          The URL of this game's logo image.

        • banner_url string

          The URL of this game's banner image.

      • namespaces object[] required

        A list of namespace summaries.

        • namespace_id string required

          Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

          A universally unique identifier.

        • create_ts date-time required

          RFC3339 timestamp.

        • display_name string required

          Possible values: 1 ≤ length ≤ 24, Value must match regular expression ^(?:[^ \n\r] ?)+[^ \n\r]$

          Represent a resource's readable display name.

        • version_id string required

          Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

          A universally unique identifier.

        • name_id string required

          Possible values: 1 ≤ length ≤ 16, Value must match regular expression ^[a-zA-Z0-9](?:[a-zA-Z0-9]-?)+[a-zA-Z0-9]$

          A human readable short identifier used to references resources.

          Different than a rivet.common#Uuid because this is intended to be human readable.

          Different than rivet.common#DisplayName because this should not include special characters and be short.

      • expenses object[] required

        A list of multiple region tier expenses.

        • namespace_id string required

          Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

          A universally unique identifier.

        • region_id string required

          Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

          A universally unique identifier.

        • tier_name_id string required

          Possible values: 1 ≤ length ≤ 16, Value must match regular expression ^[a-zA-Z0-9](?:[a-zA-Z0-9]-?)+[a-zA-Z0-9]$

          A human readable short identifier used to references resources.

          Different than a rivet.common#Uuid because this is intended to be human readable.

          Different than rivet.common#DisplayName because this should not include special characters and be short.

        • lobby_group_name_id string required

          Possible values: 1 ≤ length ≤ 16, Value must match regular expression ^[a-zA-Z0-9](?:[a-zA-Z0-9]-?)+[a-zA-Z0-9]$

          A human readable short identifier used to references resources.

          Different than a rivet.common#Uuid because this is intended to be human readable.

          Different than rivet.common#DisplayName because this should not include special characters and be short.

        • uptime int64 required

          How long a region tier has been active (in milliseconds).

        • expenses int64 required

          Amount of expenses for this region tier (in hundred-thousandths USD, 100,000 = $1.00).

    • balance int64 required

      A group's available balance.

  • bank_source password required
  • available_regions object[] required

    A list of region summaries.

    • region_id string required

      Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

      A universally unique identifier.

    • region_name_id string required

      Possible values: 1 ≤ length ≤ 16, Value must match regular expression ^[a-zA-Z0-9](?:[a-zA-Z0-9]-?)+[a-zA-Z0-9]$

      A human readable short identifier used to references resources.

      Different than a rivet.common#Uuid because this is intended to be human readable.

      Different than rivet.common#DisplayName because this should not include special characters and be short.

    • provider string required

      The server provider of this region.

    • universal_region number required

      A universal number given to this region.

    • provider_display_name string required

      Possible values: 1 ≤ length ≤ 24, Value must match regular expression ^(?:[^ \n\r] ?)+[^ \n\r]$

      Represent a resource's readable display name.

    • region_display_name string required

      Possible values: 1 ≤ length ≤ 24, Value must match regular expression ^(?:[^ \n\r] ?)+[^ \n\r]$

      Represent a resource's readable display name.