PacSpace Docs

Checkpoint - Period-End

Commit checkpoint proofs, list historical checkpoints, and compare two checkpoints over a customer timeline.

Use checkpoints to lock a period-end proof over verified deltas. Checkpoints support historical replay, faster derivations, and consistent receipts.

Commit A Checkpoint

http
POST https://app.pacspace.io/api/v1/balance/checkpoint

Request Body

ParameterTypeRequiredDescription
customerIdstringNoCustomer scope. Omit to checkpoint all active customers in the resolved window.
periodstringNoMonth scope in YYYY-MM.
timePresetstringNocurrent_month, last_30_days, last_90_days, or custom.
startDatestringNoCustom scope start (ISO 8601).
endDatestringNoCustom scope end (ISO 8601).
modestringNoOptional selection mode for advanced checkpoint filtering.
fingerprintsstring[]NoOptional fingerprint subset when selection mode is enabled.

Scope Rules

  • Scope fields are mutually exclusive by mode (period/preset/custom).
  • Dashboard quick-range chips (Last 30/90 days, Last 12 months) resolve to custom with explicit startDate/endDate.
  • Scope is capped by backend limits.
  • Repeating the same request for the same resolved scope is idempotent.

Examples

typescript
import { PacSpace } from '@pacspace-io/sdk';

const pac = new PacSpace({ apiKey: process.env.PACSPACE_API_KEY! });

const checkpoint = await pac.balance.checkpoint('cust_12345', {
  period: '2026-04',
});

console.log(checkpoint.checkpointId);
console.log(checkpoint.proofRoot);

List Checkpoints

http
GET https://app.pacspace.io/api/v1/balance/checkpoints

Query filters:

  • customerId
  • period
  • timePreset
  • startDate
  • endDate
  • limit
  • offset

SDK example:

typescript
const { checkpoints } = await pac.balance.listCheckpoints({
  customerId: 'cust_12345',
  period: '2026-04',
  limit: 25,
});

Checkpoint Timeline

http
GET https://app.pacspace.io/api/v1/balance/checkpoint-timeline/:customerId

Returns:

  • Timeline points (ordered checkpoints)
  • Coverage gaps
  • Range summary

SDK example:

typescript
const timeline = await pac.balance.listCheckpointTimeline('cust_12345', {
  startDate: '2026-01-01T00:00:00.000Z',
  endDate: '2026-05-01T00:00:00.000Z',
});

Compare Two Checkpoints

http
POST https://app.pacspace.io/api/v1/balance/checkpoint-diff/:customerId

Request body:

json
{
  "leftCheckpointId": "chk_aaa...",
  "rightCheckpointId": "chk_bbb..."
}

SDK example:

typescript
const diff = await pac.balance.diffCheckpoints(
  'cust_12345',
  'chk_aaa...',
  'chk_bbb...',
);

console.log(diff.difference.netDeltaDiff);
console.log(diff.dailyDivergence.length);

Automation Cadence

Checkpoint automation supports three cadence windows:

  • monthly
  • weekly (ISO week, Mon-Sun UTC)
  • daily (previous UTC day)

In v1, daily cadence is gated to Enterprise tier records. Automatic runs remain idempotent at the checkpoint identity layer.

PreviousShared RecordNextReceipts & Verification