Skip to main content
GET
/
v1
/
topics
/
{id}
/
credits-summary
curl -X GET "https://api.trigify.io/v1/topics/topic_abc123xyz/credits-summary" \
  -H "x-api-key: YOUR_API_KEY"

{
  "message": "<string>",
  "success": true,
  "period": {
    "from": "<string>",
    "to": "<string>",
    "source": "billing_period"
  },
  "allocation_method": "split_evenly",
  "data": {
    "total_credits": 123,
    "new_post_credits": 123,
    "engagement_credits": 123,
    "billed_posts_count": 123,
    "billed_engagements_count": 123,
    "last_charged_at": "<string>",
    "engagement_credits_by_interval": [
      {
        "interval": 123,
        "credits": 123,
        "billed_engagements_count": 123
      }
    ]
  }
}
Use this endpoint to retrieve the billing-period credit summary allocated to one Social Topics search.
Enterprise-only endpoint. Contact us at [email protected] to discuss access.
This is a free read endpoint. It reports credits already allocated to the topic; it does not charge additional credits.

​
Overview

This endpoint returns the topic’s current credit allocation for the active billing period when available, or the current calendar month as a fallback. Shared billed posts and engagements are allocated evenly across all matching topic searches in the same organisation.

​
Authentication And Permissions

  • Send your API key in x-api-key
  • Required permission: topics:read
  • Required plan: ENTERPRISE or CUSTOM
curl -X GET "https://api.trigify.io/v1/topics/topic_abc123xyz/credits-summary" \
  -H "x-api-key: YOUR_API_KEY"

​
Allocation Model

  • allocation_method is always split_evenly
  • period.source is billing_period when Trigify can resolve the organisation’s current Stripe billing window
  • period.source is month_fallback when billing-period resolution is unavailable and the API falls back to the current calendar month
  • engagement_credits_by_interval breaks engagement spend down by the Social Topics scrape interval bucket (0, 1, 3, 5, or null when unavailable)

​
Example Response

{
  "success": true,
  "message": "Topic credit summary retrieved",
  "period": {
    "from": "2026-03-01T00:00:00.000Z",
    "to": "2026-03-31T23:59:59.999Z",
    "source": "billing_period"
  },
  "allocation_method": "split_evenly",
  "data": {
    "total_credits": 146,
    "new_post_credits": 21,
    "engagement_credits": 125,
    "billed_posts_count": 21,
    "billed_engagements_count": 25,
    "last_charged_at": "2026-03-09T08:10:54.000Z",
    "engagement_credits_by_interval": [
      {
        "interval": 0,
        "credits": 45,
        "billed_engagements_count": 9
      },
      {
        "interval": 1,
        "credits": 35,
        "billed_engagements_count": 7
      },
      {
        "interval": 3,
        "credits": 30,
        "billed_engagements_count": 6
      },
      {
        "interval": 5,
        "credits": 15,
        "billed_engagements_count": 3
      }
    ]
  }
}

Headers

​
x-api-key
string

Path Parameters

​
id
string
required

Topic search ID

Example:

"topic_abc123xyz"

Response

200 - application/json

Topic credit summary

​
message
string
required
​
success
boolean
required
​
period
object
required
​
allocation_method
enum<string>
required

How shared billed receipts are allocated across matching topic searches

Available options:
split_evenly
​
data
object
required