SubscriptionSummary

object

idrequired: Id
Opaque record id.
plan_coderequired: string
plan_namerequired: string
statusrequired: "trialing" | "active" | "past_due" | "paused" | "cancelled" | "expired"
cyclerequired: "monthly" | "yearly"
seatsrequired: integer
trial_ends_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
current_period_startrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
current_period_endrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
cancel_at_period_endrequired: boolean
gatewayrequired: string or null
gateway_statusrequired: string or null
period_amountrequired: BillingAmount or null
What one period costs at the current plan and seats.
pending_changerequired: object or null
pending_change.kindrequired: "checkout" | "downgrade" | "cycle_change" | "upgrade"
pending_change.plan_coderequired: string
pending_change.cyclerequired: "monthly" | "yearly"
pending_change.seatsrequired: integer
pending_change.effective_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
pending_change.checkout_urlrequired: string or null

Example

{
  "id": "cmusrceel0000q7kaafxqi1om",
  "plan_code": "string",
  "plan_name": "string",
  "status": "trialing",
  "cycle": "monthly",
  "seats": 0,
  "trial_ends_at": "2026-10-06T05:30:00.000Z",
  "current_period_start": "2026-10-06T05:30:00.000Z",
  "current_period_end": "2026-10-06T05:30:00.000Z",
  "cancel_at_period_end": true,
  "gateway": "string",
  "gateway_status": "string",
  "period_amount": {
    "taxable": 850000000,
    "gst": 850000000,
    "gross": 850000000
  },
  "pending_change": {
    "kind": "checkout",
    "plan_code": "string",
    "cycle": "monthly",
    "seats": 0,
    "effective_at": "2026-10-06T05:30:00.000Z",
    "checkout_url": "string"
  }
}