Payload

All webhook payloads follow a consistent top-level structure with event-specific data nested within the data object.

idstring

The public plan grant ID.

customerIdstring

The public customer ID.

subscriptionIdstring

The public subscription ID.

basePlanIdstring

The public ID of the subscribed base plan.

targetPlanIdstring

The public ID of the plan whose access was granted.

targetPlanReleaseIdstring

The public ID of the immutable target plan release.

status"active" | "expired" | "revoked"

The plan grant status at this transition.

duration"cycles" | "until_date" | "until_revoked"

How the plan grant duration is defined at this transition.

durationCyclesinteger | null

The cycle count when duration is cycles.

startsAtstring

When the plan grant started.

expiresAtstring | null

The effective expiration deadline, if any.

reasonstring

The reason recorded for this transition.

source"dashboard" | "api" | "system"

Where this transition originated.

revokedAtstring | null

When the plan grant was revoked, otherwise null.

createdAtstring

When the plan grant was created.

updatedAtstring

When the represented transition occurred.

eventsWebhookPlanGrantTimelineEvent[]

The grant timeline through the represented transition.

{
  "event": "plan_grant.created",
  "timestamp": "2026-06-23T14:30:00.000Z",
  "organizationId": "8f14e45f-ceea-4e7a-9c3d-1c2b3a4d5e6f",
  "mode": "live",
  "apiVersion": "2026-08-27",
  "data": {
    "id": "pgr_1a2b3c4d",
    "customerId": "user_123",
    "subscriptionId": "sub_1a2b3c4d",
    "basePlanId": "pln_starter",
    "targetPlanId": "pln_pro",
    "targetPlanReleaseId": "plr_1a2b3c4d",
    "status": "active",
    "duration": "cycles",
    "durationCycles": 2,
    "startsAt": "2026-08-01T00:00:00.000Z",
    "expiresAt": "2026-10-01T00:00:00.000Z",
    "reason": "Two-month product evaluation",
    "source": "api",
    "revokedAt": null,
    "createdAt": "2026-08-01T00:00:00.000Z",
    "updatedAt": "2026-08-01T00:00:00.000Z",
    "events": [
      {
        "id": "gre_1a2b3c4d",
        "type": "created",
        "reason": "Two-month product evaluation",
        "source": "api",
        "previousExpiresAt": null,
        "expiresAt": "2026-10-01T00:00:00.000Z",
        "duration": "cycles",
        "durationCycles": 2,
        "requestedExpiresAt": null,
        "createdAt": "2026-08-01T00:00:00.000Z"
      }
    ]
  }
}

Cuándo se dispara

Después de confirmar un Plan Grant desde la API o el dashboard. El payload representa el grant como estaba al crearse y su último evento es created.

También se dispara customer.state_changed con el trigger plan_access_granted.

plan_grant.created

Se creó un Plan Grant.