UsageBalanceSource

The entity providing the Allowance to the Subscription.

  • Name
    type
    Type
    string
    Description

    The entity type providing the allowance.

    Allowed values: subscriptionPeriod subscriptionAddon 
  • Name
    subscriptionPeriod
    Type
    nullable integer
    Description

    When the allowance is provided by the subscription's plan, the subscription period this usage balance is bound by.

    Optional: This property may not always be included.
    Example: 4
  • Name
    subscriptionAddon
    Type
    nullable string
    Description

    When the allowance is provided by a Subscription Add-on, the subscription add-on this usage balance is provided by.

    Optional: This property may not always be included.
    Example: "sad_0SNlurA049MEWV2UNWPbDfW5B40U"

Example

{
  "type": "subscriptionPeriod",
  "subscriptionPeriod": 4,
  "subscriptionAddon": null
}