EZezypay

Record a partner subscription add on usage

Changed on

Record the active member count for each partner subscription to bill a merchant according to member 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

Path parameters

partnerSubscriptionIdstring required

Auto-generated unique identifier of the partner subscription.

partnerSubscriptionAddOnCodestring required

Existing partner subscription add on code associated to the partner subscription. Partner subscription add on type must be set to amount_per_usage.

Headers

merchantstring required

Merchant ID

Request body

valuestring required

Specify a positive integer inclusive of 0.

displayMeasurementUnitstring

Specify a unit of measurement to describe the value. Max of 100 characters.

referenceCodestring

Specify the custom, external ID used to identify this usage entry for an external system.

recordingTimestampstring

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

object required

Changes