action namsor_api_usage {
  label: "Print current API usage."
  provider: namsor
  method: GET
  path: "/api2/json/apiUsage"
  encoding: json
  output: {
    type: "object"
    properties: {
      billingPeriod: {
        type: "object"
        description: "The current billing period."
        properties: {
          apiKey: {
            type: "string"
            description: "User API Key."
          }
          billingStatus: {
            type: "string"
            description: "Current period billing status ex OPEN."
          }
          hardLimit: {
            type: "integer"
            format: "int64"
            description: "Current period hard limit (reaching the limit sends an email notification and blocks the API Key)."
          }
          periodEnded: {
            type: "integer"
            format: "int64"
            description: "Datetime when the the plan's current period endend."
          }
          periodStarted: {
            type: "integer"
            format: "int64"
            description: "Datetime when the the plan's current period started."
          }
          softLimit: {
            type: "integer"
            format: "int64"
            description: "Current period soft limit (reaching the limit sends an email notification)."
          }
          stripeCurrentPeriodEnd: {
            type: "integer"
            format: "int64"
            description: "Datetime when the the plan's current period endend (in Stripe). Internal and Stripe periodicity should ~coincide."
          }
          stripeCurrentPeriodStart: {
            type: "integer"
            format: "int64"
            description: "Datetime when the the plan's current period started (in Stripe). Internal and Stripe periodicity should ~coincide."
          }
          subscriptionStarted: {
            type: "integer"
            format: "int64"
            description: "Datetime when the user subscribed to the plan."
          }
          usage: {
            type: "integer"
            format: "int64"
            description: "Current period usage in units (NB some API endpoints use more than one unit)."
          }
        }
      }
      overageCurrency: {
        type: "string"
        description: "Currency of the overage amount."
      }
      overageExclTax: {
        type: "number"
        format: "double"
        description: "Overage amount including any tax."
      }
      overageInclTax: {
        type: "number"
        format: "double"
        description: "Overage amount including tax (if applicable)."
      }
      overageQuantity: {
        type: "integer"
        format: "int64"
        description: "Quantity above monthly quota of the current subscritpion, in units."
      }
      subscription: {
        type: "object"
        description: "The API Plan governing the subscription."
        properties: {
          apiKey: {
            type: "string"
            description: "User API Key."
          }
          currency: {
            type: "string"
            description: "Current plan Currency for prices."
          }
          currencyFactor: {
            type: "number"
            format: "double"
            description: "For USD, GBP, EUR - the factor is 1."
          }
          planBaseFeesKey: {
            type: "string"
            description: "Current plan key (as in Stripe product)."
          }
          planEnded: {
            type: "integer"
            format: "int64"
            description: "Datetime when the user ended the plan."
          }
          planName: {
            type: "string"
            description: "Current plan name."
          }
          planQuota: {
            type: "integer"
            format: "int64"
            description: "Current plan quota in quantity of units (NB: some API use several units per name)."
          }
          planStarted: {
            type: "integer"
            format: "int64"
            description: "Datetime when the user subscribed to the current plan."
          }
          planStatus: {
            type: "string"
            description: "Plan status."
          }
          price: {
            type: "number"
            format: "double"
            description: "Current plan price for overages expressed in Currency (extra price per unit above the free quota)."
          }
          priceOverage: {
            type: "number"
            format: "double"
            description: "Current plan price for overages expressed in Currency (extra price per unit above the free quota)."
          }
          priceOverageUSD: {
            type: "number"
            format: "double"
            description: "Current plan price for overages expressed in USD (extra price per unit above the free quota)."
          }
          priceUSD: {
            type: "number"
            format: "double"
            description: "Current plan monthly price expressed in USD (includes a free quota)."
          }
          priorPlanStarted: {
            type: "integer"
            format: "int64"
            description: "Datetime when the user subscribed to the prior plan."
          }
          stripeCustomerId: {
            type: "string"
            description: "Stripe customer identifier."
          }
          stripeStatus: {
            type: "string"
            description: "Stripe status ex active."
          }
          stripeSubscription: {
            type: "string"
            description: "Stripe subscription identifier."
          }
          taxRate: {
            type: "number"
            format: "double"
            description: "Applicable tax rate for the plan."
          }
          userId: {
            type: "string"
            description: "Internal user identifier."
          }
        }
      }
    }
  }
}