KIkiwify
Parcelado

GET /scheduled-installments

Changed on

Obtenha uma lista dos planos do Parcelado Kiwify da loja. O período máximo entre o created_start e o created_end é de 90 dias.

Request

  • Base URL
    https://public-api.kiwify.com/v1
  • URL
    https://public-api.kiwify.com/v1/scheduled-installments
  • Auth
    API key in header x-kiwify-account-id and OAuth 2
    Client credentials
    Token URL: /oauth/token scopes: scheduled_installments

Query parameters

page_sizestring

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

page_numberstring

Número da página.

created_startstring

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

created_endstring

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

product_idstring

Filtra por produto.

offer_idstring

Filtra por oferta.

payment_methodstring[]

Filtra por método de pagamento.

statusstring[]

Filtra por status do plano.

customerstring

Filtra por nome ou e-mail do cliente.

Response

Lista de planos do Parcelado

Example response

{
  "pagination": {
    "count": 10,
    "page_number": 1,
    "page_size": 10
  },
  "data": []
}

Changes