SubscriptionChangeResult

object

kindrequired: "upgrade" | "downgrade" | "unchanged" | "cycle_change"
charge_nowrequired: BillingAmount
Prorated for the rest of the period: added to the next charge, or (yearly cycles) paid now via `payment_url`.
effective_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
payment_urlrequired: string or null
Yearly upgrades: pay the prorated difference here; the upgrade applies once it is paid.
subscriptionrequired: SubscriptionSummary

Example

{
  "kind": "upgrade",
  "charge_now": {
    "taxable": 850000000,
    "gst": 850000000,
    "gross": 850000000
  },
  "effective_at": "2026-10-06T05:30:00.000Z",
  "payment_url": "string",
  "subscription": {
    "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"
    }
  }
}