Skip to content

Report usage

If metered usage is a pricing dimension of your product and you've defined one or more metered levers, you will likely need to report customer usage to Planship. Metered usage is reported for a metering ID, which is associated with one or more metered levers.

const meteringRecord = await planship.reportUsage(
  customer.id, // customer ID
  'some-metering-id', // metering ID
  15, // reported usage
)

const meteringRecord: MeteringRecord = await planship.reportUsage(
  customer.id, // customer ID
  'some-metering-id', // metering ID
  15, // reported usage
)

metering_record = planship.report_usage(
    customer.id, # customer ID
    "some-metering-id", # metering ID
    15, # reported usage
)

MeteringRecord meteringRecord = planship.reportUsage(
    customer.getId(), // customer ID
    "some-metering-id", // metering ID
    15, // reported usage
)

Every time usage is reported, Planship creates a metering record for traceability. Metering records are automatically processed and aggregated in the background and included in the totals for all usage levers with a matching metering ID.

Reporting bucketed usage

If your product defines usage levers that take advantage of usage per bucket or unique buckets aggregation formulas, you will want to include a bucket identifier when reporting usage to Planship.

const meteringRecord = await planship.reportUsage(
  customer.id, // customer ID
  'some-metering-id', // metering ID
  15, // reported usage
  'bucket-name', // usage bucket
)

const meteringRecord: MeteringRecord = await planship.reportUsage(
  customer.id, // customer ID
  'some-metering-id', // metering ID
  15, // reported usage
  'bucket-name', // usage bucket
)

metering_record = planship.report_usage(
    customer.id, # customer ID
    "some-metering-id", # metering ID
    15, # reported usage
    "bucket-name", // usage bucket
)

MeteringRecord meteringRecord = planship.reportUsage(
    customer.getId(), // customer ID
    "some-metering-id", // metering ID
    15, // reported usage
    "bucket-name", // usage bucket
)

The specified bucket value becomes part of the metering record and is used by Planship's usage processing engine.

Check current usage

While the remaining usage is returned as part of a customer's entitlements, you may want to retrieve the actual, current customer usage for a given metered usage lever.

const leverUsage = await planship.geLeverUsage(
  customer.id, // customer ID
  'usage-lever', // lever slug
)

const leverUsage: LeverUsage = await planship.geLeverUsage(
  customer.id, // customer ID
  'usage-lever', // lever slug
)

lever_usage = planship.get_lever_usage(
    customer.id, # customer ID
    "usage-lever", # lever slug
)

LeverUsage leverUsage = planship.geLeverUsage(
    customer.getId(), // customer ID
    "usage-lever", // lever slug
)

The returned object contains the usage by bucket, by subscription, and total usage:

// Example usage for a lever that aggregates usage per bucket
{
  'total': 5,
  'byBucket': {
    'First project': 3,
    'Second project': 2
  },
  'bySubscription': {
    'c49c142e-310c-44b7-86bd-c4de568bc4ac': [
      {
        'usage': 3,
        'bucket': 'First project'
      }, {
        'usage': 2,
        'bucket': 'Second project'
      }
    ]
  }
}

// Example usage for a lever that aggregates usage per bucket
{
    'total': 5,
    'byBucket': {
      'First project': 3,
      'Second project': 2
    },
    'bySubscription': {
      'c49c142e-310c-44b7-86bd-c4de568bc4ac': [
        {
          'usage': 3,
          'bucket': 'First project'
        }, {
          "usage": 2,
          "bucket": "Second project"
        }
      ]
    }
}

# Example usage for a lever that aggregates usage per bucket
{
    "total": 5,
    "by_bucket": {
        "First project": 3,
        "Second project": 2
    },
    "by_subscription": {
        "c49c142e-310c-44b7-86bd-c4de568bc4ac": [
            {
                "usage": 3,
                "bucket": "First project"
            }, {
                "usage": 2,
                "bucket": "Second project"
            }
        ]
    }
}

Info

Depending on the aggregation formula for a given lever, some of the properties of the returned object may be irrelevant. For instance, for a Total usage formula, usage-per-bucket will always be the same as total usage, and reported under a single null bucket.

/// Example usage for a lever that aggregates total usage
{
  'total': 5,
  'byBucket': {
    'null': 5,
  },
  'bySubscription': {
    'c49c142e-310c-44b7-86bd-c4de568bc4ac': [
      {
        'usage': 5,
        'bucket': null
      }
    ]
  }
}

/// Example usage for a lever that aggregates total usage
{
  'total': 5,
  'byBucket': {
    'null': 5,
  },
  'bySubscription': {
    'c49c142e-310c-44b7-86bd-c4de568bc4ac': [
      {
        'usage': 5,
        'bucket': null
      }
    ]
  }
}

# Example usage for a lever that aggregates total usage
{
  "total": 5,
  "by_bucket": {
      "null": 5,
  },
  "by_subscription": {
      "c49c142e-310c-44b7-86bd-c4de568bc4ac": [
          {
              "usage": 5,
              "bucket": null
          }
      ]
  }
}

Getting usage for multiple levers

If you have multiple levers that track usage for the same metering ID (E.g. aggregating it over a different time period), it may be helpful to retrieve usage for the levers all at once.

const meteringIdUsage = await planship.getMeteringIdUsage(
  customer.id, // customer ID
  'some-metering-id', // metering ID
)

const meteringIdUsage: { [key: string]: LeverUsage}  = await planship.getMeteringIdUsage(
  customer.id, // customer ID
  'some-metering-id', // metering ID
)

metering_id_usage = planship.get_metering_id_usage(
    customer.id, # customer ID
    "some-metering-id", # metering ID
)

Object meteringIdUsage = planship.getMeteringIdUsage(
    customer.getId(), // customer ID
    "some-metering-id", // metering ID
)

The return value is an object containing usage data for individual levers keyed by their slugs.