PApagar

Listar itens de uma assinatura

Changed on

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

get/subscriptions/{subscription_id}/items

Request

  • Base URL
    https://api.pagar.me/core/v5
  • URL
    https://api.pagar.me/core/v5/subscriptions/{subscription_id}/items
  • Auth
    HTTP basic

Path parameters

subscription_idstring required

Request body

statusstring

Status da assinatura.<br>Valores possíveis: active, *deleted

namestring

Nome do item da assinatura.

descriptionstring

Descrição do item.

cycleinteger

Indica quantas vezes o item será cobrado. <br>Caso não seja informado, o item será cobrado até que seja excluído o desativado.

created_sincestring date

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

created_untilstring date-time

Data final do item de criação a ser listado.

pageinteger

Página atual

sizeinteger

Quantidade de itens por página.

Response

200

Example response

{
  "data": [
    {
      "id": "si_ZqbrJQ6udHLolQ5W",
      "description": "iPhone APP",
      "cycles": 1,
      "quantity": 1,
      "status": "active",
      "created_at": "2018-05-25T19:23:13Z",
      "updated_at": "2018-05-25T19:23:13Z",
      "pricing_scheme": {
        "price": 99,
        "scheme_type": "unit"
      }
    }
  ],
  "paging": {
    "total": 3
  }
}

Changes