Subscription

Get Notification Service Plan Usage Summary

Get the current usage summary for a notification service plan.

GET
/nudge/subscription/usage-summary

Authorization

clientKeyHeader clientSecretHeader
x-client-key<token>

Client API key credential.

In: header

x-client-secret<token>

Client API secret credential.

In: header

Query Parameters

serviceId*string

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.dokaai.com/api/v1/dokaai/nudge/subscription/usage-summary?serviceId=string"
{
  "status": "success",
  "message": "string",
  "data": {
    "planName": "string",
    "currentUsagePeriodTimeline": {
      "startDate": "string",
      "endDate": "string"
    },
    "subscriptionServiceType": "notification",
    "summary": {
      "totalQuotaLimit": 0,
      "totalOverage": 0,
      "totalQuotaUsed": 0,
      "totalOverageUsed": 0
    }
  },
  "metaData": null,
  "error": null
}
{
  "status": "error",
  "message": "string",
  "data": null,
  "metaData": null,
  "error": null
}
{
  "status": "error",
  "message": "string",
  "data": null,
  "metaData": null,
  "error": null
}
{
  "status": "error",
  "message": "string",
  "data": null,
  "metaData": null,
  "error": null
}
{
  "status": "error",
  "message": "string",
  "data": null,
  "metaData": null,
  "error": null
}