Paylogos

Listar planos

Em desenvolvimento

GET

https://api.paylogos.com.br/v1/recurrence_plans

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://api.paylogos.com.br/v1/recurrence_plans?limit=20&sort=time-descending&offset=0&date_range&date_range[gt]&date_range[gte]&date_range[lt]&date_range[lte]'

Response Example

200 - Exemplo 1

{
    "resource": "string",
    "uri": "string",
    "limit": 0,
    "offset": 0,
    "has_more": true,
    "total": 0,
    "items": [
        {
            "uuid": "string",
            "frequency": "daily",
            "interval": 0,
            "payment_methods": [
                "string"
            ],
            "amount": 0,
            "setup_amount": 0,
            "currency": "string",
            "description": "string",
            "name": "string",
            "duration": 0,
            "status": "active",
            "resource": "string",
            "created_at": "string",
            "updated_at": "string",
            "uri": "string"
        }
    ]
}

Requisição

Parâmetros Query

limit

number

opcional

Limita o número de objetos retornados, podendo ser entre 1 e 100

Padrão:

Exemplo:

sort

string

opcional

Determinar como ordenar a lista em relação a data de criação do objeto

Padrão:

time-descending

Exemplo:

time-descending

offset

number

opcional

Determina o ponto de inicio dos registros retornados

Exemplo:

date_range

number

opcional

Filtro na lista base de objetos pela data de criação. O valor pode ser uma string com um horário em UTC timestamp, ou pode ser uma lista com os parametros abaixo

date_range[gt]

number

opcional

Retorna valores onde a data maior que o timestamp informado

date_range[gte]

number

opcional

Retorna valores onde a data for maior ou igual que o timestamp informado

date_range[lt]

number

opcional

Retorna valores onde a data for menor que o timestamp informado

date_range[lte]

number

opcional

Retorna valores onde a data for menor ou igual que o timestamp informado

Respostas

🟢200search results matching criteria

application/json

Body

resource

string

opcional

uri

string

opcional

limit

number

opcional

offset

number

opcional

has_more

boolean

opcional

total

number

opcional

items

array[object (PlanoRecorrenciaReturn) {15}]

opcional

uuid

string

opcional

frequency

string

requerido

Frequencia que o plano será cobrado

Exemplo:

dailymonthlyweeklyannually

interval

integer

requerido

Intervalo entre frequencia de cobrança

payment_methods

array[string]

requerido

Métodos de pagamento utilizados

amount

integer

opcional

Valor plano em centavos

setup_amount

integer

opcional

Valor do setup do plano em centavos

currency

string

opcional

Moeda utilizada

description

string

opcional

Descrição do plano

name

string

requerido

Nome do plano

duration

integer

opcional

Tempo de duração do plano em relação à frequencia escolhida

status

string

opcional

Status do plano

Exemplo:

activecanceled

resource

string

opcional

created_at

string

opcional

Criado em

updated_at

string

opcional

Atualizado em

uri

string

opcional

🟠400bad input parameter

Modificado em 2025-06-10 21:00:03

Página anterior

Criar um plano

Próxima página

Recupera um plano pelo identificador