EZezypay

List partner subscription add on usage

Changed on

Retrieve a list of partner subscription add on usages and filter the results using the available options.

get/partnersubscriptions/{partnerSubscriptionId}/addons/{partnerSubscriptionAddOnCode}

Request

  • Base URL
    https://api-sandbox.ezypay.com/v2
  • URL
    https://api-sandbox.ezypay.com/v2/partnersubscriptions/{partnerSubscriptionId}/addons/{partnerSubscriptionAddOnCode}
  • 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.

Query parameters

referenceCodestring

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

recordingTimestampFromstring

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.

recordingTimestampUntilstring

Specify the end for range of object to view based on date defined in recordingTimestamp. Supported format is yyyy-MM-ddTHH:mm:ss or yyyy-MM-ddTHH:mm:ss.SSS.

createdFromstring

Specify the start for range of object to view based on auto-generated date in createdOn. Supported format is yyyy-MM-ddTHH:mm:ss or yyyy-MM-ddTHH:mm:ss.SSS.

createdUntilstring

Specify the end for range of object to view based on auto-generated date in createdOn. Supported format is yyyy-MM-ddTHH:mm:ss or yyyy-MM-ddTHH:mm:ss.SSS.

limitinteger

To paginate a large result set, use the 'limit' argument to limit the number of results returned per page up to a maximum of 100 records. For example, limit = 10 shows results 1-10. The default returned result would be 100.

cursorinteger

An cursor for use in pagination. Specify the number of objects to skip to fetch the next page of objects. For example, limit=10 and cursor=10 will show results for record 11 - 20.

Headers

merchantstring required

Merchant ID

Response

200

object required

Changes