KIkiwify
Parcelado

GET /scheduled-installments/{id}

Changed on

Consulte os detalhes de um plano do Parcelado Kiwify e suas parcelas, passando o id do plano.

Request

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

Path parameters

idstring required

Response

Detalhes do plano do Parcelado

idstring
created_atstring date-time
statusstring
payment_methodstring
installment_quantitynumber
total_amountnumber
interest_totalnumber
next_charge_datestring nullable

Example response

{
  "id": "b8f0c2b4-2f1e-4a2c-9d3a-1f2e3d4c5b6a",
  "created_at": "2026-01-10T13:00:00.000Z",
  "status": "active",
  "payment_method": "credit_card",
  "installment_quantity": 12,
  "total_amount": 120000,
  "interest_total": 20000,
  "next_charge_date": "2026-04-10",
  "customer_access": {
    "has_access": true
  },
  "charges": {
    "completed": [
      {
        "installment_number": 4,
        "due_date": "2026-04-10",
        "amount": 10000,
        "status": "open"
      }
    ],
    "future": [
      {
        "installment_number": 4,
        "due_date": "2026-04-10",
        "amount": 10000,
        "status": "open"
      }
    ]
  },
  "product": {
    "id": "c05a1348-059d-43d5-9856-06958f50db8a",
    "name": "Meu Produto"
  },
  "customer": {
    "name": "cliente 1",
    "email": "cliente1@mail.com"
  },
  "purchase_order": {
    "id": "928e2ff2-ef23-4147-ba46-b5e1b3a844db",
    "ref_id": "EV9pCMk"
  }
}

Changes