Kiwify API

https://docs.kiwify.com.br/
Admin
The Kiwify API provides a RESTful interface for integrating with the Kiwify platform, allowing users...
Tokens:133,796
Snippets:1,063
Trust Score:9.9
Update:2 hours ago
Show doc for...
Tokens:
Raw
### Go GET request to list scheduled installments

Source: https://docs.kiwify.com.br/api-reference/scheduled-installments/list

Uses the net/http package to send a GET request to the Kiwify scheduled installments endpoint. Prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://public-api.kiwify.com/v1/scheduled-installments"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-kiwify-account-id", "<api-key>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### Go example for single affiliate

Source: https://docs.kiwify.com.br/api-reference/affiliates/single

Go example using net/http to GET an affiliate by ID. Prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://public-api.kiwify.com/v1/affiliates/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-kiwify-account-id", "<api-key>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### Go example for balance

Source: https://docs.kiwify.com.br/api-reference/finance/balance/list

Go example using net/http to GET the balance endpoint. Prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://public-api.kiwify.com/v1/balance"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-kiwify-account-id", "<api-key>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### 200 Response Example

Source: https://docs.kiwify.com.br/api-reference/scheduled-installments/single

Example JSON response for a successful GET request. Shows installment details, charges, product, customer, and purchase order.

```json
{
  "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": 1,
        "due_date": "2026-01-10",
        "amount": 10000,
        "status": "paid"
      },
      {
        "installment_number": 2,
        "due_date": "2026-02-10",
        "amount": 10000,
        "status": "paid"
      },
      {
        "installment_number": 3,
        "due_date": "2026-03-10",
        "amount": 10000,
        "status": "paid"
      }
    ],
    "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"
  }
}
```

--------------------------------

### Ruby Net::HTTP GET to list scheduled installments

Source: https://docs.kiwify.com.br/api-reference/scheduled-installments/list

Uses the Net::HTTP library to send a GET request to the Kiwify scheduled installments endpoint. Prints the response body.

```ruby
require 'uri'
require 'net/http'

url = URI("https://public-api.kiwify.com/v1/scheduled-installments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-kiwify-account-id"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

--------------------------------

### JavaScript fetch example for single affiliate

Source: https://docs.kiwify.com.br/api-reference/affiliates/single

JavaScript example using fetch to GET an affiliate by ID. Replace {id} and credentials as needed.

```javascript
const options = {
  method: 'GET',
  headers: {'x-kiwify-account-id': '<api-key>', Authorization: 'Bearer <token>'}
};

fetch('https://public-api.kiwify.com/v1/affiliates/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

--------------------------------

### Python requests example for balance

Source: https://docs.kiwify.com.br/api-reference/finance/balance/list

Python example using the requests library to GET the balance endpoint. Prints the response text.

```python
import requests

url = "https://public-api.kiwify.com/v1/balance"

headers = {
    "x-kiwify-account-id": "<api-key>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)
```

--------------------------------

### Ruby example for single affiliate

Source: https://docs.kiwify.com.br/api-reference/affiliates/single

Ruby example using Net::HTTP to GET an affiliate by ID. Prints the response body.

```ruby
require 'uri'
require 'net/http'

url = URI("https://public-api.kiwify.com/v1/affiliates/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-kiwify-account-id"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

--------------------------------

### Python requests example for listing products

Source: https://docs.kiwify.com.br/api-reference/products/list

Uses the requests library to GET /v1/products. Requires the same headers as the cURL example: x-kiwify-account-id and Authorization Bearer token.

```python
import requests

url = "https://public-api.kiwify.com/v1/products"

headers = {
    "x-kiwify-account-id": "<api-key>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)
```

--------------------------------

### JavaScript fetch example for balance

Source: https://docs.kiwify.com.br/api-reference/finance/balance/list

JavaScript example using fetch to GET the balance endpoint. Logs the JSON response or error.

```javascript
const options = {
  method: 'GET',
  headers: {'x-kiwify-account-id': '<api-key>', Authorization: 'Bearer <token>'}
};

fetch('https://public-api.kiwify.com/v1/balance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

--------------------------------

### Ruby Net::HTTP example for balance

Source: https://docs.kiwify.com.br/api-reference/finance/balance/list

Ruby example using Net::HTTP to GET the balance endpoint. Prints the response body.

```ruby
require 'uri'
require 'net/http'

url = URI("https://public-api.kiwify.com/v1/balance")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-kiwify-account-id"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

--------------------------------

### Go example

Source: https://docs.kiwify.com.br/api-reference/affiliates/list

Uses net/http to GET the affiliates endpoint and prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://public-api.kiwify.com/v1/affiliates"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-kiwify-account-id", "<api-key>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### 200 response example for scheduled installments list

Source: https://docs.kiwify.com.br/api-reference/scheduled-installments/list

Example JSON response returned by the Kiwify scheduled installments endpoint. Shows pagination metadata and a data array with installment details such as status, payment method, installment quantity, next charge date, product, and customer information.

```json
{
  "pagination": {
    "count": 1,
    "page_number": 1,
    "page_size": 10
  },
  "data": [
    {
      "id": "b8f0c2b4-2f1e-4a2c-9d3a-1f2e3d4c5b6a",
      "created_at": "2026-01-10T13:00:00.000Z",
      "status": "active",
      "payment_method": "credit_card",
      "installment_quantity": 12,
      "installments": {
        "paid": 3,
        "total": 12
      },
      "next_charge_date": "2026-04-10",
      "customer_access": {
        "has_access": true
      },
      "product": {
        "id": "c05a1348-059d-43d5-9856-06958f50db8a",
        "name": "Meu Produto"
      },
      "customer": {
        "name": "cliente 1",
        "email": "cliente1@mail.com"
      }
    }
  ]
}
```

--------------------------------

### GET /scheduled-installments

Source: https://docs.kiwify.com.br/api-reference/scheduled-installments/list

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

```APIDOC
## [GET] /scheduled-installments

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

### Method
GET

### Endpoint
https://public-api.kiwify.com/v1/scheduled-installments

### Parameters
#### Header Parameters
- **x-kiwify-account-id** (string) - Obrigatório - Identificador da conta Kiwify.
- **Authorization** (string) - Obrigatório - Token de acesso recebido do servidor de autorização no fluxo OAuth 2.0.

#### Query Parameters
- **page_size** (string) - Opcional - Quantidade de itens por página (máximo 100).
- **page_number** (string) - Opcional - Número da página.
- **created_start** (string) - Opcional - Data inicial (YYYY-MM-DD), fuso America/Sao_Paulo. Exige created_end.
- **created_end** (string) - Opcional - Data final (YYYY-MM-DD), fuso America/Sao_Paulo. Exige created_start.
- **product_id** (string) - Opcional - Filtra por produto.
- **offer_id** (string) - Opcional - Filtra por oferta.
- **payment_method** (enum<string>[]) - Opcional - Filtra por método de pagamento. Opções: `pix`, `boleto`, `credit_card`.
- **status** (enum<string>[]) - Opcional - Filtra por status do plano. Opções: `active`, `overdue`, `settled`, `paused`, `cancelled`.
- **customer** (string) - Opcional - Filtra por nome ou e-mail do cliente.

### Request Example
```
curl --request GET \
  --url https://public-api.kiwify.com/v1/scheduled-installments \
  --header 'Authorization: Bearer <token>' \
  --header 'x-kiwify-account-id: <api-key>'
```

### Response
#### Success Response (200)
- **pagination** (object) - Informações de paginação.
- **data** (any[]) - Lista de planos do Parcelado.

#### Response Example
```
{
  "pagination": {
    "count": 1,
    "page_number": 1,
    "page_size": 10
  },
  "data": [
    {
      "id": "b8f0c2b4-2f1e-4a2c-9d3a-1f2e3d4c5b6a",
      "created_at": "2026-01-10T13:00:00.000Z",
      "status": "active",
      "payment_method": "credit_card",
      "installment_quantity": 12,
      "installments": {
        "paid": 3,
        "total": 12
      },
      "next_charge_date": "2026-04-10",
      "customer_access": {
        "has_access": true
      },
      "product": {
        "id": "c05a1348-059d-43d5-9856-06958f50db8a",
        "name": "Meu Produto"
      },
      "customer": {
        "name": "cliente 1",
        "email": "cliente1@mail.com"
      }
    }
  ]
}
```
```

--------------------------------

### Python requests example for single affiliate

Source: https://docs.kiwify.com.br/api-reference/affiliates/single

Python example using the requests library to GET an affiliate by ID. Requires the requests package and valid API credentials.

```python
import requests

url = "https://public-api.kiwify.com/v1/affiliates/{id}"

headers = {
    "x-kiwify-account-id": "<api-key>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)
```

--------------------------------

### Go GET Sale by ID

Source: https://docs.kiwify.com.br/api-reference/sales/single

Go example using net/http to fetch a sale by ID. Prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://public-api.kiwify.com/v1/sales/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-kiwify-account-id", "<api-key>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### Python GET Sale by ID

Source: https://docs.kiwify.com.br/api-reference/sales/single

Python example using the requests library to fetch a sale by ID. Requires the requests package and the same headers as the cURL example.

```python
import requests

url = "https://public-api.kiwify.com/v1/sales/{id}"

headers = {
    "x-kiwify-account-id": "<api-key>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)
```

--------------------------------

### JavaScript fetch GET Sale by ID

Source: https://docs.kiwify.com.br/api-reference/sales/single

JavaScript example using fetch to retrieve a sale by ID. Uses the same headers and URL as the other examples.

```javascript
const options = {
  method: 'GET',
  headers: {'x-kiwify-account-id': '<api-key>', Authorization: 'Bearer <token>'}
};

fetch('https://public-api.kiwify.com/v1/sales/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

--------------------------------

### Go - Get Single Webhook

Source: https://docs.kiwify.com.br/api-reference/webhooks/single

Go example using net/http to fetch a single webhook. Prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://public-api.kiwify.com/v1/webhooks/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-kiwify-account-id", "<api-key>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### Java Unirest example for balance

Source: https://docs.kiwify.com.br/api-reference/finance/balance/list

Java example using Unirest to GET the balance endpoint. Returns the response as a string.

```java
HttpResponse<String> response = Unirest.get("https://public-api.kiwify.com/v1/balance")
  .header("x-kiwify-account-id", "<api-key>")
  .header("Authorization", "Bearer <token>")
  .asString();
```

--------------------------------

### Ruby example

Source: https://docs.kiwify.com.br/api-reference/affiliates/list

Uses Net::HTTP to GET the affiliates endpoint and prints the response body.

```ruby
require 'uri'
require 'net/http'

url = URI("https://public-api.kiwify.com/v1/affiliates")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-kiwify-account-id"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

--------------------------------

### PHP cURL example for balance

Source: https://docs.kiwify.com.br/api-reference/finance/balance/list

PHP example using cURL to GET the balance endpoint. Handles errors and prints the response.

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://public-api.kiwify.com/v1/balance",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "x-kiwify-account-id: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

--------------------------------

### Python requests example

Source: https://docs.kiwify.com.br/api-reference/affiliates/list

Uses the requests library to GET the affiliates endpoint. Prints the response text.

```python
import requests

url = "https://public-api.kiwify.com/v1/affiliates"

headers = {
    "x-kiwify-account-id": "<api-key>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)
```

--------------------------------

### Go GET request to /v1/stats

Source: https://docs.kiwify.com.br/api-reference/sales/stats

Sends a GET request to the Kiwify stats endpoint using Go's net/http package. Prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://public-api.kiwify.com/v1/stats"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-kiwify-account-id", "<api-key>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### JavaScript fetch example

Source: https://docs.kiwify.com.br/api-reference/affiliates/list

Uses fetch to GET the affiliates endpoint and logs the JSON response or error.

```javascript
const options = {
  method: 'GET',
  headers: {'x-kiwify-account-id': '<api-key>', Authorization: 'Bearer <token>'}
};

fetch('https://public-api.kiwify.com/v1/affiliates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

--------------------------------

### Ruby GET Sale by ID

Source: https://docs.kiwify.com.br/api-reference/sales/single

Ruby example using Net::HTTP to fetch a sale by ID. Prints the response body.

```ruby
require 'uri'
require 'net/http'

url = URI("https://public-api.kiwify.com/v1/sales/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-kiwify-account-id"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

--------------------------------

### Java Unirest example

Source: https://docs.kiwify.com.br/api-reference/affiliates/list

Uses Unirest to GET the affiliates endpoint and returns the response as a string.

```java
HttpResponse<String> response = Unirest.get("https://public-api.kiwify.com/v1/affiliates")
  .header("x-kiwify-account-id", "<api-key>")
  .header("Authorization", "Bearer <token>")
  .asString();
```

--------------------------------

### Go example for listing products

Source: https://docs.kiwify.com.br/api-reference/products/list

Uses net/http to GET /v1/products. Adds the required headers and prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://public-api.kiwify.com/v1/products"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-kiwify-account-id", "<api-key>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### Ruby Net::HTTP example for listing products

Source: https://docs.kiwify.com.br/api-reference/products/list

Uses Net::HTTP to GET /v1/products. Sets the required headers and prints the response body.

```ruby
require 'uri'
require 'net/http'

url = URI("https://public-api.kiwify.com/v1/products")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-kiwify-account-id"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

--------------------------------

### Java Unirest GET to list scheduled installments

Source: https://docs.kiwify.com.br/api-reference/scheduled-installments/list

Uses the Unirest HTTP library to send a GET request to the Kiwify scheduled installments endpoint. Returns the response as a string.

```java
HttpResponse<String> response = Unirest.get("https://public-api.kiwify.com/v1/scheduled-installments")
  .header("x-kiwify-account-id", "<api-key>")
  .header("Authorization", "Bearer <token>")
  .asString();
```

--------------------------------

### JavaScript fetch example for listing products

Source: https://docs.kiwify.com.br/api-reference/products/list

Uses the Fetch API to GET /v1/products with the required headers. Logs the JSON response or an error.

```javascript
const options = {
  method: 'GET',
  headers: {'x-kiwify-account-id': '<api-key>', Authorization: 'Bearer <token>'}
};

fetch('https://public-api.kiwify.com/v1/products', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

--------------------------------

### PHP cURL GET to list scheduled installments

Source: https://docs.kiwify.com.br/api-reference/scheduled-installments/list

Uses PHP cURL to perform a GET request to the Kiwify scheduled installments endpoint. Prints the response or a cURL error message.

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://public-api.kiwify.com/v1/scheduled-installments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "x-kiwify-account-id: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

--------------------------------

### JavaScript fetch GET to list scheduled installments

Source: https://docs.kiwify.com.br/api-reference/scheduled-installments/list

Uses the Fetch API to send a GET request to the Kiwify scheduled installments endpoint. Logs the JSON response or error to the console.

```javascript
const options = {
  method: 'GET',
  headers: {'x-kiwify-account-id': '<api-key>', Authorization: 'Bearer <token>'}
};

fetch('https://public-api.kiwify.com/v1/scheduled-installments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

--------------------------------

### is_preview Example with Output

Source: https://docs.kiwify.com.br/members-area/reference/objects/is_preview

This example shows how to display a message only inside the editor. The output is the rendered HTML when the flag is true.

```liquid
{% if is_preview %}
<p>Isso aparece apenas dentro do editor</p>
{% endif %}
```

```html
<p>Isso aparece apenas dentro do editor</p>
```

--------------------------------

### cURL GET request to list scheduled installments

Source: https://docs.kiwify.com.br/api-reference/scheduled-installments/list

Sends a GET request to the Kiwify public API endpoint /v1/scheduled-installments. Requires an Authorization Bearer token and the x-kiwify-account-id header with your API key.

```bash
curl --request GET \
  --url https://public-api.kiwify.com/v1/scheduled-installments \
  --header 'Authorization: Bearer <token>' \
  --header 'x-kiwify-account-id: <api-key>'
```

--------------------------------

### Java Unirest example for listing products

Source: https://docs.kiwify.com.br/api-reference/products/list

Uses Unirest to GET /v1/products with the required headers. Returns an HttpResponse<String>.

```java
HttpResponse<String> response = Unirest.get("https://public-api.kiwify.com/v1/products")
  .header("x-kiwify-account-id", "<api-key>")
  .header("Authorization", "Bearer <token>")
  .asString();
```

--------------------------------

### Go GET to /v1/account-details

Source: https://docs.kiwify.com.br/api-reference/account/account-details

Go example using net/http to call the account-details endpoint. Prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://public-api.kiwify.com/v1/account-details"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-kiwify-account-id", "<api-key>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### Python requests GET to list scheduled installments

Source: https://docs.kiwify.com.br/api-reference/scheduled-installments/list

Uses the requests library to call the Kiwify scheduled installments endpoint. Prints the response text. Requires the x-kiwify-account-id and Authorization headers.

```python
import requests

url = "https://public-api.kiwify.com/v1/scheduled-installments"

headers = {
    "x-kiwify-account-id": "<api-key>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)
```

--------------------------------

### GET /v1/scheduled-installments

Source: https://docs.kiwify.com.br/api-reference/scheduled-installments/list

Retrieves a list of scheduled installments for the authenticated account. This endpoint requires authentication via Bearer token and an account ID header.

```APIDOC
## [GET] /v1/scheduled-installments

### Description
Retrieves a list of scheduled installments for the authenticated account.

### Method
GET

### Endpoint
https://public-api.kiwify.com/v1/scheduled-installments

### Parameters
#### Headers
- **Authorization** (string) - Required - Bearer token for authentication.
- **x-kiwify-account-id** (string) - Required - API key for the account.

### Response
#### Success Response (200)
- **pagination** (object) - Pagination details.
  - **count** (integer) - Total number of items.
  - **page_number** (integer) - Current page number.
  - **page_size** (integer) - Number of items per page.
- **data** (array) - List of scheduled installments.
  - **id** (string) - Unique identifier of the scheduled installment.
  - **created_at** (string) - Creation timestamp in ISO 8601 format.
  - **status** (string) - Status of the installment (e.g., "active").
  - **payment_method** (string) - Payment method used (e.g., "credit_card").
  - **installment_quantity** (integer) - Total number of installments.
  - **installments** (object) - Installment details.
    - **paid** (integer) - Number of paid installments.
    - **total** (integer) - Total number of installments.
  - **next_charge_date** (string) - Date of the next charge in YYYY-MM-DD format.
  - **customer_access** (object) - Customer access information.
    - **has_access** (boolean) - Whether the customer has access.
  - **product** (object) - Product details.
    - **id** (string) - Product ID.
    - **name** (string) - Product name.
  - **customer** (object) - Customer details.
    - **name** (string) - Customer name.
    - **email** (string) - Customer email.

#### Response Example
```json
{
  "pagination": {
    "count": 1,
    "page_number": 1,
    "page_size": 10
  },
  "data": [
    {
      "id": "b8f0c2b4-2f1e-4a2c-9d3a-1f2e3d4c5b6a",
      "created_at": "2026-01-10T13:00:00.000Z",
      "status": "active",
      "payment_method": "credit_card",
      "installment_quantity": 12,
      "installments": {
        "paid": 3,
        "total": 12
      },
      "next_charge_date": "2026-04-10",
      "customer_access": {
        "has_access": true
      },
      "product": {
        "id": "c05a1348-059d-43d5-9856-06958f50db8a",
        "name": "Meu Produto"
      },
      "customer": {
        "name": "cliente 1",
        "email": "cliente1@mail.com"
      }
    }
  ]
}
```
```

--------------------------------

### Go GET Scheduled Installment

Source: https://docs.kiwify.com.br/api-reference/scheduled-installments/single

Uses net/http to fetch a scheduled installment. Prints response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://public-api.kiwify.com/v1/scheduled-installments/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-kiwify-account-id", "<api-key>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### Ruby GET Scheduled Installment

Source: https://docs.kiwify.com.br/api-reference/scheduled-installments/single

Uses Net::HTTP to fetch a scheduled installment. Prints response body.

```ruby
require 'uri'
require 'net/http'

url = URI("https://public-api.kiwify.com/v1/scheduled-installments/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-kiwify-account-id"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

--------------------------------

### Example: Display course name with all_courses

Source: https://docs.kiwify.com.br/members-area/reference/objects/all_courses

Shows how to output the name of a specific course using its ID. The example uses 'my-course' as the ID and expects a data structure with a 'name' field, producing the output 'Culinária 101'.

```Liquid
{{ all_courses["my-course"].name }}
```

```JSON
// Apenas dados iniciais de exemplo, os dados não são reais
{
  "all_courses": {
    "my-course": {
      "name": "Culinária 101"
    }
  }
}
```

```Text
Culinária 101
```

--------------------------------

### Java Unirest GET Scheduled Installment

Source: https://docs.kiwify.com.br/api-reference/scheduled-installments/single

Uses Unirest to retrieve a scheduled installment. Returns response as string.

```java
HttpResponse<String> response = Unirest.get("https://public-api.kiwify.com/v1/scheduled-installments/{id}")
  .header("x-kiwify-account-id", "<api-key>")
  .header("Authorization", "Bearer <token>")
  .asString();
```

--------------------------------

### JavaScript Fetch GET Scheduled Installment

Source: https://docs.kiwify.com.br/api-reference/scheduled-installments/single

Fetches a scheduled installment using fetch API. Logs response or error.

```javascript
const options = {
  method: 'GET',
  headers: {'x-kiwify-account-id': '<api-key>', Authorization: 'Bearer <token>'}
};

fetch('https://public-api.kiwify.com/v1/scheduled-installments/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

--------------------------------

### PHP cURL GET Scheduled Installment

Source: https://docs.kiwify.com.br/api-reference/scheduled-installments/single

Uses cURL in PHP to retrieve a scheduled installment. Handles errors and prints response.

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://public-api.kiwify.com/v1/scheduled-installments/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "x-kiwify-account-id: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

--------------------------------

### for loop - example with fruits

Source: https://docs.kiwify.com.br/members-area/reference/tags/iteration

Displays a list of fruits using a for loop. The collection is created by splitting a string by comma.

```liquid
{% assign fruits = "maçã,banana,laranja" | split: "," %}

<ul>
{% for fruit in fruits %}
  <li>{{ fruit }}</li>
{% endfor %}
</ul>
```

```html
<ul>
  <li>maçã</li>
  <li>banana</li>
  <li>laranja</li>
</ul>
```

--------------------------------

### Python GET Scheduled Installment

Source: https://docs.kiwify.com.br/api-reference/scheduled-installments/single

Uses requests library to fetch a scheduled installment. Requires API key and token in headers.

```python
import requests

url = "https://public-api.kiwify.com/v1/scheduled-installments/{id}"

headers = {
    "x-kiwify-account-id": "<api-key>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)
```

--------------------------------

### 200 OK response for /v1/stats

Source: https://docs.kiwify.com.br/api-reference/sales/stats

Example successful response from the stats endpoint. Contains sales metrics such as credit_card_approval_rate, total_sales, total_net_amount, refund_rate, chargeback_rate, and boleto-related fields.

```json
{
  "credit_card_approval_rate": 50,
  "total_sales": 3,
  "total_net_amount": 25956,
  "refund_rate": 25,
  "chargeback_rate": 0,
  "total_boleto_generated": 2,
  "total_boleto_paid": 1,
  "boleto_rate": 50
}
```

--------------------------------

### cURL GET Scheduled Installment

Source: https://docs.kiwify.com.br/api-reference/scheduled-installments/single

Retrieves a scheduled installment by ID using cURL. Requires Authorization Bearer token and x-kiwify-account-id header.

```bash
curl --request GET \
  --url https://public-api.kiwify.com/v1/scheduled-installments/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-kiwify-account-id: <api-key>'
```

--------------------------------

### GET /v1/scheduled-installments/{id}

Source: https://docs.kiwify.com.br/api-reference/scheduled-installments/single

Retrieves details of a scheduled installment by its unique identifier. This endpoint returns information about the installment plan, including charges, product, customer, and purchase order details.

```APIDOC
## [GET] /v1/scheduled-installments/{id}

### Description
Retrieves details of a scheduled installment by its unique identifier. This endpoint returns information about the installment plan, including charges, product, customer, and purchase order details.

### Method
GET

### Endpoint
https://public-api.kiwify.com/v1/scheduled-installments/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the scheduled installment.

#### Headers
- **Authorization** (string) - Required - Bearer token for authentication.
- **x-kiwify-account-id** (string) - Required - The API key for the Kiwify account.

### Request Example
No request body required.

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the scheduled installment.
- **created_at** (string) - The creation timestamp in ISO 8601 format.
- **status** (string) - The status of the installment (e.g., active).
- **payment_method** (string) - The payment method used (e.g., credit_card).
- **installment_quantity** (integer) - The total number of installments.
- **total_amount** (integer) - The total amount in cents.
- **interest_total** (integer) - The total interest amount in cents.
- **next_charge_date** (string) - The date of the next charge in YYYY-MM-DD format.
- **customer_access** (object) - Contains access information for the customer.
  - **has_access** (boolean) - Whether the customer has access.
- **charges** (object) - Contains completed and future charges.
  - **completed** (array) - List of completed charges.
    - **installment_number** (integer) - The installment number.
    - **due_date** (string) - The due date in YYYY-MM-DD format.
    - **amount** (integer) - The amount in cents.
    - **status** (string) - The status of the charge (e.g., paid).
  - **future** (array) - List of future charges.
    - **installment_number** (integer) - The installment number.
    - **due_date** (string) - The due date in YYYY-MM-DD format.
    - **amount** (integer) - The amount in cents.
    - **status** (string) - The status of the charge (e.g., open).
- **product** (object) - The product associated with the installment.
  - **id** (string) - The product ID.
  - **name** (string) - The product name.
- **customer** (object) - The customer information.
  - **name** (string) - The customer name.
  - **email** (string) - The customer email.
- **purchase_order** (object) - The purchase order information.
  - **id** (string) - The purchase order ID.
  - **ref_id** (string) - The reference ID.

#### Response Example
```json
{
  "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": 1,
        "due_date": "2026-01-10",
        "amount": 10000,
        "status": "paid"
      },
      {
        "installment_number": 2,
        "due_date": "2026-02-10",
        "amount": 10000,
        "status": "paid"
      },
      {
        "installment_number": 3,
        "due_date": "2026-03-10",
        "amount": 10000,
        "status": "paid"
      }
    ],
    "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"
  }
}
```
```

--------------------------------

### Example: Get lesson name with all_lessons

Source: https://docs.kiwify.com.br/members-area/reference/objects/all_lessons

This example shows how to access a specific lesson's name using `all_lessons["my-lesson"]`. The output displays the lesson name. The data block is sample initial data, not real data.

```liquid
{{ all_lessons["my-lesson"].name }}
```

```json
// Apenas dados iniciais de exemplo, os dados não são reais
{
  "all_lessons": {
    "my-lesson": {
      "name": "Como fazer uma torta de maçã"
    }
  }
}
```

```text
Como fazer uma torta de maçã
```

--------------------------------

### POST /payouts/

Source: https://docs.kiwify.com.br/api-reference/finance/payouts/create

Solicita a realização de um saque. Exige o cabeçalho Idempotency-Key, um UUID gerado por você que identifica o saque. Este endpoint é de natureza síncrona, o que significa que você terá uma resposta imediata, porém, para saber o status da solicitação, será necessário consultar o dashboard, no menu financeiro, na aba “Saques”.

```APIDOC
## [POST] /payouts/

### Description
Solicita a realização de um saque. Exige o cabeçalho Idempotency-Key, um UUID gerado por você que identifica o saque. Este endpoint é de natureza síncrona, o que significa que você terá uma resposta imediata, porém, para saber o status da solicitação, será necessário consultar o dashboard, no menu financeiro, na aba “Saques”.

### Method
POST

### Endpoint
https://public-api.kiwify.com/v1/payouts/

### Parameters
#### Headers
- **Idempotency-Key** (string<uuid>) - Obrigatório - Identificador único do saque, gerado por você. Envie um UUID novo para cada saque que pretende criar, e reenvie o mesmo valor, inalterado, em qualquer nova tentativa da mesma solicitação — uma retentativa após timeout ou erro de rede devolve o saque original em vez de criar um segundo. Este UUID é o `id` do saque, e pode ser usado em seguida para consultá-lo. Requisições sem este cabeçalho são recusadas com 400. Exemplo: `"8606aae0-e036-4e55-998a-e0a8de7bf54f"`
- **x-kiwify-account-id** (string) - Obrigatório - Cabeçalho de autorização.
- **Authorization** (string) - Obrigatório - O access token recebido do servidor de autorização no fluxo OAuth 2.0.

#### Request Body
- **amount** (number) - Obrigatório - Valor do saque. Exemplo: `5000`

### Request Example
```json
{
  "amount": 5000
}
```

### Response
#### Success Response (200)
- **id** (string) - O identificador do saque.

#### Response Example
```json
{
  "id": "8606aae0-e036-4e55-998a-e0a8de7bf54f"
}
```

### Error Handling
- **400** - Requisições sem o cabeçalho `Idempotency-Key` são recusadas com 400.
```
Tokens:
Raw