Purchases allow you to track customer transactions and connect them to your subscribers for better segmentation and targeting.

​
List purchases

Returns a list of all purchases for your account.

​
Endpoint

GET /v3/purchases

​
Parameters

​
api_secret
string
required
Your API secret key
​
page
integer
The page of results being requested. Default value is 1. Each page of results will contain up to 50 purchases.
curl https://api.convertkit.com/v3/purchases?api_secret=<your_secret_api_key>

​
Retrieve a specific purchase

Show specific purchase by ID.

​
Endpoint

GET /v3/purchases/#{purchase_id}

​
Parameters

​
api_secret
string
required
Your API secret key
​
purchase_id
integer
required
The ID of the purchase you want to retrieve
curl https://api.convertkit.com/v3/purchases/<purchase_id>?api_secret=<your_secret_api_key>

​
Create a purchase

Create a new purchase record for tracking customer transactions.

​
Endpoint

POST /v3/purchases

​
Parameters

​
api_secret
string
required
Your API secret key
​
purchase
object
required
Purchase object

​
Required for Third Party Integrations

We no longer support new integrations with V3 of the API. Instead learn more about building apps with the Kit App Store here
​
purchase.integration
string
required
The name of your integration (e.g. eBay)
​
integration_key
string
required
A token for tracking integrations
curl -X POST https://api.convertkit.com/v3/purchases \
     -H 'Content-Type: application/json' \
     -d '{ "api_secret": "<your_secret_api_key>",
           "purchase": {
                "transaction_id": "123-abcd-456-efgh",
                "email_address": "[email protected]",
                "first_name": "John",
                "currency": "jpy",
                "transaction_time": "2018-03-17 11:28:04",
                "subtotal": 20.00,
                "tax": 2.00,
                "shipping": 2.00,
                "discount": 3.00,
                "total": 21.00,
                "status": "paid",
                "products": [{
                    "pid": 9999,
                    "lid": 7777,
                    "name": "Floppy Disk (512k)",
                    "sku": "7890-ijkl",
                    "unit_price": 5.00,
                    "quantity": 2
                }, {
                    "pid": 5555,
                    "lid": 7778,
                    "name": "Telephone Cord (data)",
                    "sku": "mnop-1234",
                    "unit_price": 10.00,
                    "quantity": 1
                }]
           }
     }'