Obter um agendamento de assinatura

Retorna uma subscription_schedule pelo ID. Use este endpoint para entender qual fase está ativa, quais fases ainda serão aplicadas, qual subscription está sob controle da agenda e o que acontecerá quando a última fase terminar. Para buscar schedules por subscription ou status, use Listar Subscription Schedules.

string

required

ID da schedule (subsched_*).

curl "https://api.chargefy.io/v1/subscription-schedules/subsched_R767gJBHng3VXr4p" \
  -H "Authorization: Bearer {{API_KEY}}"

200

{
  "id": "subsched_R767gJBHng3VXr4p",
  "object": "subscription_schedule",
  "canceled_at": null,
  "completed_at": null,
  "created_at": "2026-05-20T12:00:00Z",
  "current_phase": null,
  "current_phase_index": null,
  "customer": "cus_uwoMN1JJGwB1LStS",
  "end_behavior": "release",
  "livemode": true,
  "metadata": {},
  "phases": {
    "object": "list",
    "data": [],
    "has_more": false,
    "url": "/v1/subscription-schedules/subsched_R767gJBHng3VXr4p/phases"
  },
  "released_at": null,
  "released_subscription": null,
  "start_date": "2026-05-20T12:00:00Z",
  "status": "not_started",
  "subscription": "sub_KvWoQScMNc52bQX1",
  "updated_at": null
}

Campos para observar

Campo	Por que importa
`status`	Mostra se a schedule ainda não começou, está ativa, foi concluída, cancelada ou liberada.
`current_phase`	Intervalo da fase em vigor; vem `null` quando a primeira fase ainda não começou ou depois do término.
`current_phase_index`	Índice da fase atual dentro de `phases.data[]`.
`phases.data[]`	Sequência de fases que serão aplicadas à assinatura.
`end_behavior`	Define se a assinatura será liberada ou cancelada ao final da última fase.
`released_subscription`	Subscription que seguiu sem schedule depois de uma release.

Erros comuns

401

{
  "error": {
    "code": "authentication_failed",
    "message": "Invalid API key provided.",
    "type": "authentication_error"
  }
}

404

{
  "error": {
    "code": "resource_missing",
    "message": "Subscription schedule not found.",
    "param": "id",
    "type": "invalid_request_error"
  }
}

Fundamentos da API

Objetos de sistema

Webhooks e eventos

SDKs

MCP

Obter um agendamento de assinatura

Campos para observar

Erros comuns

​Campos para observar

​Erros comuns

Campos para observar

Erros comuns