Skip to main content
GET
cURL

Autorizações

x-kiwify-account-id
string
header
obrigatório
Authorization
string
header
obrigatório

The access token received from the authorization server in the OAuth 2.0 flow.

Parâmetros de consulta

page_size
string

Quantidade de itens por página (máximo 100).

page_number
string

Número da página.

created_start
string

Data inicial (YYYY-MM-DD), fuso America/Sao_Paulo. Exige created_end.

created_end
string

Data final (YYYY-MM-DD), fuso America/Sao_Paulo. Exige created_start.

product_id
string

Filtra por produto.

offer_id
string

Filtra por oferta.

payment_method
enum<string>[]

Filtra por método de pagamento.

Opções disponíveis:
pix,
boleto,
credit_card
status
enum<string>[]

Filtra por status do plano.

Opções disponíveis:
active,
overdue,
settled,
paused,
cancelled
customer
string

Filtra por nome ou e-mail do cliente.

Resposta

200 - application/json

Lista de planos do Parcelado

pagination
object
data
any[]
Exemplo: