Skip to main content
Uma subscription_schedule agenda mudanças automáticas em uma subscription. Cada fase define itens, cobrança, trial e comportamento de proration para o momento em que ela começa.
{
  "id": "subsched_123",
  "object": "subscription_schedule",
  "canceled_at": null,
  "completed_at": null,
  "created_at": "2026-05-20T12:00:00Z",
  "current_phase": {
    "end_date": "2026-06-20T12:00:00Z",
    "start_date": "2026-05-20T12:00:00Z"
  },
  "current_phase_index": 0,
  "customer": "cus_123",
  "end_behavior": "release",
  "livemode": true,
  "metadata": {},
  "phases": {
    "object": "list",
    "data": [
      {
        "id": "subphase_123",
        "object": "subscription_schedule_phase",
        "collection_method": "charge_automatically",
        "created_at": "2026-05-20T12:00:00Z",
        "days_until_due": null,
        "default_payment_method": "pm_123",
        "discount": null,
        "end_date": "2026-06-20T12:00:00Z",
        "items": [
          {
            "price": "price_pro",
            "quantity": 1
          }
        ],
        "metadata": {},
        "phase_index": 0,
        "proration_behavior": "create_prorations",
        "start_date": "2026-05-20T12:00:00Z",
        "trial_end": null,
        "trial_settings": null,
        "updated_at": null
      }
    ],
    "has_more": false,
    "url": "/v1/subscription-schedules/subsched_123/phases"
  },
  "released_at": null,
  "released_subscription": null,
  "start_date": "2026-05-20T12:00:00Z",
  "status": "active",
  "subscription": "sub_123",
  "updated_at": null
}
id
string
ID da schedule (subsched_*).
end_behavior
string
release mantém a subscription ativa após a última fase. cancel cancela a subscription no fim da última fase.
status
string
not_started, active, completed, released ou canceled.
phases
object
Lista de fases sequenciais aplicadas à subscription.