v1

latestOpenAPI 3.1.02026-07-241040774.6 KB

Listar ciclos

Este recurso permite listar os ciclos associados a uma assinatura. Podem ser utilizados alguns parâmetros como filtro da listagem.

get/subscriptions/{subscription_id}/cycles

Path parameters

subscription_idstring required

Código da assinatura.<br>Formato: sub_XXXXXXXXXXXXXXXX.

Query parameters

idstring

Código do ciclo. Formato: cycle_XXXXXXXXXXXXXXXX.

billing_atstring date

Data de cobrança do ciclo

cyclestring

Quantidade de ciclos na assinatura

start_atstring

Data de início do ciclo

end_atstring

Data final do ciclo

durationstring

created_atstring

Data de criação da assinatura

updated_atstring date

Data de atualização do ciclo da assinatura.

statusstring

Status dos ciclos. Valores possíveis: billed ou unbilled

Response

200

Example response

{
  "data": [
    {
      "id": "cycle_Qal5a0LCpphoDpnR",
      "billing_at": "2019-04-30T00:00:00Z",
      "cycle": 1,
      "start_at": "2019-04-30T00:00:00Z",
      "end_at": "2019-07-29T23:59:59Z",
      "duration": 7862399,
      "created_at": "2019-04-30T18:09:32Z",
      "updated_at": "2019-04-30T18:09:33Z",
      "status": "billed"
    }
  ],
  "paging": {
    "total": 1
  }
}