SerenAI

Pay Per Call Agentic Commerce

DailyClaimEligibilityResponse

Response for daily claim eligibility check

Properties

PropertyTypeRequiredDescription
can_claim boolean Yes
claim_amount_usd string,null No Formatted USD amount that will be granted on a successful daily claim. Optional to avoid breaking older clients.
claims_remaining_this_month integer Yes
reason string,null No
resets_in_seconds integer,null No Seconds until the daily claim resets (midnight UTC). Only present when can_claim is false due to already claiming today.
View JSON Schema
{
  "type": "object",
  "description": "Response for daily claim eligibility check",
  "required": [
    "can_claim",
    "claims_remaining_this_month"
  ],
  "properties": {
    "can_claim": {
      "type": "boolean"
    },
    "claim_amount_usd": {
      "type": [
        "string",
        "null"
      ],
      "description": "Formatted USD amount that will be granted on a successful daily claim.\nOptional to avoid breaking older clients."
    },
    "claims_remaining_this_month": {
      "type": "integer",
      "format": "int32"
    },
    "reason": {
      "type": [
        "string",
        "null"
      ]
    },
    "resets_in_seconds": {
      "type": [
        "integer",
        "null"
      ],
      "format": "int64",
      "description": "Seconds until the daily claim resets (midnight UTC).\nOnly present when can_claim is false due to already claiming today."
    }
  }
}