v1

latestOpenAPI 3.1.02026-07-241040774.6 KB

Listar planos

Este recurso permite listar seus planos. Pode ser utilizados alguns parâmetros como filtro da listagem.

get/plans

Query parameters

namestring

Nome do plano.

statusstring

Status do plano.<br>Valores possíveis: active, inactive ou deleted

created_sincestring date

Data de início do período de criação a ser listado.

created_untilstring

Data final do período de criação a ser listado.

pageinteger

Página atual.

sizeinteger

Quantidade de itens por página.

Response

200

Example response

{
  "data": [
    {
      "id": "plan_21r4CTG0ux77Qv13",
      "name": "Plano Gold",
      "url": "/plan_21r4CTG0ux77Qv13/academia/plano-gold",
      "minimum_price": 10000,
      "currency": "BRL",
      "interval": "month",
      "interval_count": 3,
      "billing_type": "prepaid",
      "installments": 3,
      "status": "active",
      "created_at": "2016-07-12T18:25:40Z",
      "updated_at": "2016-07-12T18:25:40Z",
      "items": [
        {
          "id": "pi_3j1EG9ousipHjcUL",
          "name": "Musculação",
          "status": "active",
          "created_at": "2016-07-12T18:25:40Z",
          "updated_at": "2016-07-12T18:25:40Z",
          "pricing_scheme": {
            "price": 18990,
            "scheme_type": "unit"
          }
        }
      ],
      "metadata": {
        "id": "my_plan_id"
      }
    }
  ],
  "paging": {
    "total_items": 1,
    "current_page": 1,
    "total_pages": 1
  }
}