Skip to content
ContentRemovalDeskDocumentation

Operate & monitor

Usage & billing

Measure active API scan schedule time and understand the configured estimates available to your agency.

REST API · JSONv0.2.0 · Live CRD integration
On this page

The unit is active creator time

A linked creator with an active API scan schedule for a full UTC calendar month contributes one creator-month. Partial months are prorated by elapsed active time. Enrollment alone does not start this meter; activation starts an interval and pausing ends it.

Aliases, official URLs, and ordinary API requests are not separate creator profiles. The configured commercial rate belongs to your agency agreement. An unset rate leaves estimates unavailable; it is not a separate API permission or approval gate.

Usage calculationtext
creator_months = active creator seconds ÷ seconds in the UTC month
subtotal = creator_months × configured monthly creator rate

Read a monthly estimate

GET /v1/usage?month=YYYY-MM requires usage:read. Omit month for the current UTC month. The result includes creator_seconds, creator_months, active_creator_count, measured_through, currency, and estimates in integer cents.

active_creator_count counts creators contributing positive time during the measured period, not everyone currently enrolled. Unconfigured pricing fields are null. The live billing_basis is active_api_scan_schedule.

Manage the agreement in your agency dashboard

Use Usage & billing in /agency/api to review usage and the billing tools CRD has configured for the agreement. The usage response is an estimate; it is not an invoice or a payment confirmation.

When CRD configures its live Stripe connection, payment-method setup and the customer portal use that live account. CRD administrators can create a real draft invoice for a completed month. Draft creation does not automatically finalize, send, or charge the invoice.

CRD subscription and API scheduling are separate

API usage measures the API-owned scan schedule. It does not change or cancel the underlying creator subscription, and it is not a measurement of all CRD account activity.

Agree pricing and the collection process with CRD before enrolling paying clients. Do not infer a production price from placeholder examples or null estimate fields.

Request & response example

GET/v1/usage
curl --request GET 'https://api.crd.systems/v1/usage?month=2026-09' \
  --header "Authorization: Bearer $CRD_API_KEY"
Use your secret key in the environment variable.
Example response · 200
{
  "month": "2026-09",
  "period_start": "2026-09-01T00:00:00.000Z",
  "period_end": "2026-10-01T00:00:00.000Z",
  "measured_through": "2026-09-16T00:00:00.000Z",
  "active_creator_count": 1,
  "creator_seconds": 1296000,
  "creator_months": 0.5,
  "estimated_subtotal_cents": null,
  "minimum_monthly_cents": null,
  "estimated_total_cents": null,
  "currency": "EUR",
  "estimate": true,
  "simulated": false,
  "scope": "agency",
  "billing_basis": "active_api_scan_schedule"
}

Illustrative response. Replace example resource IDs with the IDs returned by your API requests. View endpoint details.