Bonus claim admin
Package: agentrouter.billing.v1 Service: BonusClaimAdminService
Endpoints
List bonus claims
Changed in v0.11.0 (new features): Administrators can review, approve, reject and cancel bonus claims, and reveal contact details, through the API.
Connect / gRPC only
What it does: Pages through the claims, with filters.
Request fields:
| Field | Required | Description |
|---|---|---|
customer_id | no | undocumented |
page | no | 1-based. Zero means the first page. |
page_size | no | At most 100. Zero means 25. |
status | no | undocumented |
risk_tier | no | undocumented |
source | no | undocumented |
domain_category | no | undocumented |
email_domain | no | undocumented |
user_id | no | undocumented |
search | no | A substring of the claim id, the user id or the email domain. |
date_from | no | YYYY-MM-DD or an RFC 3339 time, on create_time. |
date_to | no | undocumented |
sort_by | no | "create_time" (the default), "status", "risk_tier" or "expire_time". |
sort_ascending | no | undocumented |
Response fields:
| Field | Required | Description |
|---|---|---|
claims | no | undocumented |
total_count | no | undocumented |
{"signatures":{"go":"c.BonusClaimAdmin().ListBonusClaims(ctx, \u0026billingv1.ListBonusClaimsRequest{...})","python":"client.bonusclaimadmin.listbonusclaims(...)","typescript":"client.bonusclaimadmin.listbonusclaims({...})"},"examples":{"go":"// No Go SDK wrapper for BonusClaimAdminService yet -- use the CLI or curl example below.","python":"# No Python SDK wrapper for BonusClaimAdminService yet -- use the CLI or curl example below.","typescript":"// No TypeScript SDK wrapper for BonusClaimAdminService yet -- use the CLI or curl example below."},"persona":"Admin","slug":"list-bonus-claims"}Get bonus claim statistics
Changed in v0.11.0 (new features): Administrators can review, approve, reject and cancel bonus claims, and reveal contact details, through the API.
Connect / gRPC only
What it does: Counts the claims by status: over the last 24 hours and 7 days, or over a date range.
Request fields:
| Field | Required | Description |
|---|---|---|
customer_id | no | undocumented |
date_from | no | With either date set, the counts are over the range; otherwise over the last 24 hours and the last 7 days. |
date_to | no | undocumented |
Response fields:
| Field | Required | Description |
|---|---|---|
last_24h | no | Set without a date range. |
last_7d | no | undocumented |
range | no | Set with a date range. |
award_rate | no | awarded / (awarded + rejected + expired), over last_24h or range. |
pending_payment_count | no | undocumented |
under_review_count | no | undocumented |
{"signatures":{"go":"c.BonusClaimAdmin().GetBonusClaimStats(ctx, \u0026billingv1.GetBonusClaimStatsRequest{...})","python":"client.bonusclaimadmin.getbonusclaimstats(...)","typescript":"client.bonusclaimadmin.getbonusclaimstats({...})"},"examples":{"go":"// No Go SDK wrapper for BonusClaimAdminService yet -- use the CLI or curl example below.","python":"# No Python SDK wrapper for BonusClaimAdminService yet -- use the CLI or curl example below.","typescript":"// No TypeScript SDK wrapper for BonusClaimAdminService yet -- use the CLI or curl example below."},"persona":"Admin","slug":"get-bonus-claim-statistics"}Get a bonus claim
Changed in v0.11.0 (new features): Administrators can review, approve, reject and cancel bonus claims, and reveal contact details, through the API.
Connect / gRPC only
What it does: Returns one claim with its payment verifications, charge reviews, ledger entries and the other recent claims of its email domain.
Request fields:
| Field | Required | Description |
|---|---|---|
customer_id | no | undocumented |
claim_id | no | undocumented |
Response fields:
| Field | Required | Description |
|---|---|---|
claim | no | undocumented |
payment_verification | no | The newest verification. |
charge_reviews | no | undocumented |
ledger_entries | no | undocumented |
related_claims | no | Up to 5 other claims of the same email domain that the caller reaches. |
{"signatures":{"go":"c.BonusClaimAdmin().GetBonusClaim(ctx, \u0026billingv1.GetBonusClaimRequest{...})","python":"client.bonusclaimadmin.getbonusclaim(...)","typescript":"client.bonusclaimadmin.getbonusclaim({...})"},"examples":{"go":"// No Go SDK wrapper for BonusClaimAdminService yet -- use the CLI or curl example below.","python":"# No Python SDK wrapper for BonusClaimAdminService yet -- use the CLI or curl example below.","typescript":"// No TypeScript SDK wrapper for BonusClaimAdminService yet -- use the CLI or curl example below."},"persona":"Admin","slug":"get-a-bonus-claim"}List a review queue
Changed in v0.11.0 (new features): Administrators can review, approve, reject and cancel bonus claims, and reveal contact details, through the API.
Connect / gRPC only
What it does: Pages through the claims of one review queue.
Request fields:
| Field | Required | Description |
|---|---|---|
customer_id | no | undocumented |
queue | no | "under_review", "domain_cap", "suspicious_volume" or "stale_pending". |
page | no | undocumented |
page_size | no | undocumented |
Response fields:
| Field | Required | Description |
|---|---|---|
claims | no | undocumented |
total_count | no | undocumented |
{"signatures":{"go":"c.BonusClaimAdmin().ListReviewQueue(ctx, \u0026billingv1.ListReviewQueueRequest{...})","python":"client.bonusclaimadmin.listreviewqueue(...)","typescript":"client.bonusclaimadmin.listreviewqueue({...})"},"examples":{"go":"// No Go SDK wrapper for BonusClaimAdminService yet -- use the CLI or curl example below.","python":"# No Python SDK wrapper for BonusClaimAdminService yet -- use the CLI or curl example below.","typescript":"// No TypeScript SDK wrapper for BonusClaimAdminService yet -- use the CLI or curl example below."},"persona":"Admin","slug":"list-a-review-queue"}Count the review queues
Changed in v0.11.0 (new features): Administrators can review, approve, reject and cancel bonus claims, and reveal contact details, through the API.
Connect / gRPC only
What it does: Counts the claims of each review queue.
Request fields:
| Field | Required | Description |
|---|---|---|
customer_id | no | undocumented |
Response fields:
| Field | Required | Description |
|---|---|---|
counts | no | undocumented |
{"signatures":{"go":"c.BonusClaimAdmin().GetReviewQueueCounts(ctx, \u0026billingv1.GetReviewQueueCountsRequest{...})","python":"client.bonusclaimadmin.getreviewqueuecounts(...)","typescript":"client.bonusclaimadmin.getreviewqueuecounts({...})"},"examples":{"go":"// No Go SDK wrapper for BonusClaimAdminService yet -- use the CLI or curl example below.","python":"# No Python SDK wrapper for BonusClaimAdminService yet -- use the CLI or curl example below.","typescript":"// No TypeScript SDK wrapper for BonusClaimAdminService yet -- use the CLI or curl example below."},"persona":"Admin","slug":"count-the-review-queues"}Get the bonus claim abuse summary
Changed in v0.11.0 (new features): Administrators can review, approve, reject and cancel bonus claims, and reveal contact details, through the API.
Connect / gRPC only
What it does: Returns the claim funnel and the abuse signals of a time window. An unmasked summary (with bonus_claims.edit) is audited.
Request fields:
| Field | Required | Description |
|---|---|---|
customer_id | no | undocumented |
window_hours | no | From 1 to 720. Zero means 24. |
Response fields:
| Field | Required | Description |
|---|---|---|
window_hours | no | undocumented |
generate_time | no | undocumented |
by_source | no | source -> status -> count. |
by_risk_tier | no | undocumented |
by_domain_category | no | undocumented |
domains_at_cap_total | no | undocumented |
domains_at_cap | no | undocumented |
suspicious_domains_total | no | undocumented |
suspicious_domains | no | undocumented |
recent_fingerprint_blocks | no | undocumented |
{"signatures":{"go":"c.BonusClaimAdmin().GetBonusClaimAbuseSummary(ctx, \u0026billingv1.GetBonusClaimAbuseSummaryRequest{...})","python":"client.bonusclaimadmin.getbonusclaimabusesummary(...)","typescript":"client.bonusclaimadmin.getbonusclaimabusesummary({...})"},"examples":{"go":"// No Go SDK wrapper for BonusClaimAdminService yet -- use the CLI or curl example below.","python":"# No Python SDK wrapper for BonusClaimAdminService yet -- use the CLI or curl example below.","typescript":"// No TypeScript SDK wrapper for BonusClaimAdminService yet -- use the CLI or curl example below."},"persona":"Admin","slug":"get-the-bonus-claim-abuse-summary"}Approve a bonus claim
Changed in v0.11.0 (new features): Administrators can review, approve, reject and cancel bonus claims, and reveal contact details, through the API.
Connect / gRPC only
What it does: Awards a claim that is under review, with the credit transaction the reviewer created. A claim that is already awarded returns as it is.
Request fields:
| Field | Required | Description |
|---|---|---|
customer_id | no | undocumented |
claim_id | no | undocumented |
awarded_transaction_id | no | The credit transaction that pays the bonus. A UUID. |
note | no | At most 500 characters. |
Response fields:
| Field | Required | Description |
|---|---|---|
claim | no | undocumented |
awarded_transaction_id | no | undocumented |
{"signatures":{"go":"c.BonusClaimAdmin().ApproveBonusClaim(ctx, \u0026billingv1.ApproveBonusClaimRequest{...})","python":"client.bonusclaimadmin.approvebonusclaim(...)","typescript":"client.bonusclaimadmin.approvebonusclaim({...})"},"examples":{"go":"// No Go SDK wrapper for BonusClaimAdminService yet -- use the CLI or curl example below.","python":"# No Python SDK wrapper for BonusClaimAdminService yet -- use the CLI or curl example below.","typescript":"// No TypeScript SDK wrapper for BonusClaimAdminService yet -- use the CLI or curl example below."},"persona":"Admin","slug":"approve-a-bonus-claim"}Reject a bonus claim
Changed in v0.11.0 (new features): Administrators can review, approve, reject and cancel bonus claims, and reveal contact details, through the API.
Connect / gRPC only
What it does: Rejects a claim that is under review.
Request fields:
| Field | Required | Description |
|---|---|---|
customer_id | no | undocumented |
claim_id | no | undocumented |
reason | no | 3 to 500 characters. |
note | no | undocumented |
Response fields:
| Field | Required | Description |
|---|---|---|
claim | no | undocumented |
{"signatures":{"go":"c.BonusClaimAdmin().RejectBonusClaim(ctx, \u0026billingv1.RejectBonusClaimRequest{...})","python":"client.bonusclaimadmin.rejectbonusclaim(...)","typescript":"client.bonusclaimadmin.rejectbonusclaim({...})"},"examples":{"go":"// No Go SDK wrapper for BonusClaimAdminService yet -- use the CLI or curl example below.","python":"# No Python SDK wrapper for BonusClaimAdminService yet -- use the CLI or curl example below.","typescript":"// No TypeScript SDK wrapper for BonusClaimAdminService yet -- use the CLI or curl example below."},"persona":"Admin","slug":"reject-a-bonus-claim"}Cancel a bonus claim
Changed in v0.11.0 (new features): Administrators can review, approve, reject and cancel bonus claims, and reveal contact details, through the API.
Connect / gRPC only
What it does: Cancels a claim that is a draft, pending payment or under review.
Request fields:
| Field | Required | Description |
|---|---|---|
customer_id | no | undocumented |
claim_id | no | undocumented |
reason | no | Empty, or 3 to 500 characters. |
Response fields:
| Field | Required | Description |
|---|---|---|
claim | no | undocumented |
{"signatures":{"go":"c.BonusClaimAdmin().CancelBonusClaim(ctx, \u0026billingv1.CancelBonusClaimRequest{...})","python":"client.bonusclaimadmin.cancelbonusclaim(...)","typescript":"client.bonusclaimadmin.cancelbonusclaim({...})"},"examples":{"go":"// No Go SDK wrapper for BonusClaimAdminService yet -- use the CLI or curl example below.","python":"# No Python SDK wrapper for BonusClaimAdminService yet -- use the CLI or curl example below.","typescript":"// No TypeScript SDK wrapper for BonusClaimAdminService yet -- use the CLI or curl example below."},"persona":"Admin","slug":"cancel-a-bonus-claim"}Reveal a bonus claimant's contact details
Changed in v0.11.0 (new features): Administrators can review, approve, reject and cancel bonus claims, and reveal contact details, through the API.
Connect / gRPC only
What it does: Returns the claimant's email and lead data. Each reveal is audited, and a person can reveal at most BONUS_CLAIMS_PII_REVEAL_RATE_LIMIT claims (default 20) in an hour; more get RESOURCE_EXHAUSTED.
Request fields:
| Field | Required | Description |
|---|---|---|
customer_id | no | undocumented |
claim_id | no | undocumented |
Response fields:
| Field | Required | Description |
|---|---|---|
user_email | no | undocumented |
lead_data | no | undocumented |
reveal_time | no | undocumented |
revealed_by | no | undocumented |
{"signatures":{"go":"c.BonusClaimAdmin().RevealBonusClaimPii(ctx, \u0026billingv1.RevealBonusClaimPiiRequest{...})","python":"client.bonusclaimadmin.revealbonusclaimpii(...)","typescript":"client.bonusclaimadmin.revealbonusclaimpii({...})"},"examples":{"go":"// No Go SDK wrapper for BonusClaimAdminService yet -- use the CLI or curl example below.","python":"# No Python SDK wrapper for BonusClaimAdminService yet -- use the CLI or curl example below.","typescript":"// No TypeScript SDK wrapper for BonusClaimAdminService yet -- use the CLI or curl example below."},"persona":"Admin","slug":"reveal-a-bonus-claimants-contact-details"}