---
title: "Record a partner subscription add on usage"
method: POST
path: "/partnersubscriptions/{partnerSubscriptionId}/addons/{partnerSubscriptionAddOnCode}/recordusage"
---

# Record a partner subscription add on usage

`POST /partnersubscriptions/{partnerSubscriptionId}/addons/{partnerSubscriptionAddOnCode}/recordusage`

## Request

- Base URL: `https://api-sandbox.ezypay.com/v2`
- URL: `https://api-sandbox.ezypay.com/v2/partnersubscriptions/{partnerSubscriptionId}/addons/{partnerSubscriptionAddOnCode}/recordusage`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://identity-sandbox.ezypay.com/token`

Record the active member count for each partner subscription to bill a merchant according to member usage.

## Path parameters

- `partnerSubscriptionId` string, required
- `partnerSubscriptionAddOnCode` string, required

## Headers

- `merchant` string, required

## Request body

- object
  - `value` string, required: Specify a positive integer inclusive of 0.
  - `displayMeasurementUnit` string: Specify a unit of measurement to describe the value. Max of 100 characters.
  - `referenceCode` string: Specify the custom, external ID used to identify this usage entry for an external system.
  - `recordingTimestamp` string: Specify the start for range of objects to view based on date defined in recordingTimestamp. Supported format is yyyy-MM-ddTHH:mm:ss or yyyy-MM-ddTHH:mm:ss.SSS.

## Response `200`

200

- object

## Other responses

- `400`: 400

## Changes

- **2026-11-03** `924be4030f56`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/ezypay/apis/vault/changes/partnersubscriptions/:partnerSubscriptionId/addons/:partnerSubscriptionAddOnCode/recordusage/post.md)

---

[API](https://skmtc.dev/ezypay/apis/vault.md) - [All operations](https://skmtc.dev/ezypay/apis/vault/llms.txt) - [OpenAPI document](https://skmtc.dev/ezypay/apis/vault/revisions/924be4030f56?raw)