Create Payment Quote

curl --request POST \
  --url https://api.whop.com/api/v1/payment_quotes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "line_items": [
    {
      "plan_id": "plan_xxxxxxxxxxxxxx",
      "quantity": 1
    }
  ],
  "plan_id": "plan_xxxxxxxxxxxxxx",
  "promo_code": "SHINE20",
  "promo_code_id": "promo_xxxxxxxxxxxxxx",
  "address": {
    "city": "Austin",
    "country": "US",
    "line1": "1114 Bouldin Ave",
    "line2": "Unit B",
    "name": "Dana Whitfield",
    "postal_code": "78704",
    "state": "TX"
  },
  "ip_address": "203.0.113.7",
  "shipping_address": {
    "city": "<string>",
    "country": "<string>",
    "line1": "<string>",
    "line2": "<string>",
    "name": "<string>",
    "postal_code": "<string>",
    "state": "<string>"
  },
  "tax_ids": [
    {
      "type": "eu_vat",
      "value": "DE123456789"
    }
  ]
}
'

import requests

url = "https://api.whop.com/api/v1/payment_quotes"

payload = {
    "account_id": "biz_xxxxxxxxxxxxxx",
    "line_items": [
        {
            "plan_id": "plan_xxxxxxxxxxxxxx",
            "quantity": 1
        }
    ],
    "plan_id": "plan_xxxxxxxxxxxxxx",
    "promo_code": "SHINE20",
    "promo_code_id": "promo_xxxxxxxxxxxxxx",
    "address": {
        "city": "Austin",
        "country": "US",
        "line1": "1114 Bouldin Ave",
        "line2": "Unit B",
        "name": "Dana Whitfield",
        "postal_code": "78704",
        "state": "TX"
    },
    "ip_address": "203.0.113.7",
    "shipping_address": {
        "city": "<string>",
        "country": "<string>",
        "line1": "<string>",
        "line2": "<string>",
        "name": "<string>",
        "postal_code": "<string>",
        "state": "<string>"
    },
    "tax_ids": [
        {
            "type": "eu_vat",
            "value": "DE123456789"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    account_id: 'biz_xxxxxxxxxxxxxx',
    line_items: [{plan_id: 'plan_xxxxxxxxxxxxxx', quantity: 1}],
    plan_id: 'plan_xxxxxxxxxxxxxx',
    promo_code: 'SHINE20',
    promo_code_id: 'promo_xxxxxxxxxxxxxx',
    address: {
      city: 'Austin',
      country: 'US',
      line1: '1114 Bouldin Ave',
      line2: 'Unit B',
      name: 'Dana Whitfield',
      postal_code: '78704',
      state: 'TX'
    },
    ip_address: '203.0.113.7',
    shipping_address: {
      city: '<string>',
      country: '<string>',
      line1: '<string>',
      line2: '<string>',
      name: '<string>',
      postal_code: '<string>',
      state: '<string>'
    },
    tax_ids: [{type: 'eu_vat', value: 'DE123456789'}]
  })
};

fetch('https://api.whop.com/api/v1/payment_quotes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/payment_quotes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'account_id' => 'biz_xxxxxxxxxxxxxx',
    'line_items' => [
        [
                'plan_id' => 'plan_xxxxxxxxxxxxxx',
                'quantity' => 1
        ]
    ],
    'plan_id' => 'plan_xxxxxxxxxxxxxx',
    'promo_code' => 'SHINE20',
    'promo_code_id' => 'promo_xxxxxxxxxxxxxx',
    'address' => [
        'city' => 'Austin',
        'country' => 'US',
        'line1' => '1114 Bouldin Ave',
        'line2' => 'Unit B',
        'name' => 'Dana Whitfield',
        'postal_code' => '78704',
        'state' => 'TX'
    ],
    'ip_address' => '203.0.113.7',
    'shipping_address' => [
        'city' => '<string>',
        'country' => '<string>',
        'line1' => '<string>',
        'line2' => '<string>',
        'name' => '<string>',
        'postal_code' => '<string>',
        'state' => '<string>'
    ],
    'tax_ids' => [
        [
                'type' => 'eu_vat',
                'value' => 'DE123456789'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.whop.com/api/v1/payment_quotes"

	payload := strings.NewReader("{\n  \"account_id\": \"biz_xxxxxxxxxxxxxx\",\n  \"line_items\": [\n    {\n      \"plan_id\": \"plan_xxxxxxxxxxxxxx\",\n      \"quantity\": 1\n    }\n  ],\n  \"plan_id\": \"plan_xxxxxxxxxxxxxx\",\n  \"promo_code\": \"SHINE20\",\n  \"promo_code_id\": \"promo_xxxxxxxxxxxxxx\",\n  \"address\": {\n    \"city\": \"Austin\",\n    \"country\": \"US\",\n    \"line1\": \"1114 Bouldin Ave\",\n    \"line2\": \"Unit B\",\n    \"name\": \"Dana Whitfield\",\n    \"postal_code\": \"78704\",\n    \"state\": \"TX\"\n  },\n  \"ip_address\": \"203.0.113.7\",\n  \"shipping_address\": {\n    \"city\": \"<string>\",\n    \"country\": \"<string>\",\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"name\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"state\": \"<string>\"\n  },\n  \"tax_ids\": [\n    {\n      \"type\": \"eu_vat\",\n      \"value\": \"DE123456789\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.whop.com/api/v1/payment_quotes")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_id\": \"biz_xxxxxxxxxxxxxx\",\n  \"line_items\": [\n    {\n      \"plan_id\": \"plan_xxxxxxxxxxxxxx\",\n      \"quantity\": 1\n    }\n  ],\n  \"plan_id\": \"plan_xxxxxxxxxxxxxx\",\n  \"promo_code\": \"SHINE20\",\n  \"promo_code_id\": \"promo_xxxxxxxxxxxxxx\",\n  \"address\": {\n    \"city\": \"Austin\",\n    \"country\": \"US\",\n    \"line1\": \"1114 Bouldin Ave\",\n    \"line2\": \"Unit B\",\n    \"name\": \"Dana Whitfield\",\n    \"postal_code\": \"78704\",\n    \"state\": \"TX\"\n  },\n  \"ip_address\": \"203.0.113.7\",\n  \"shipping_address\": {\n    \"city\": \"<string>\",\n    \"country\": \"<string>\",\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"name\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"state\": \"<string>\"\n  },\n  \"tax_ids\": [\n    {\n      \"type\": \"eu_vat\",\n      \"value\": \"DE123456789\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/payment_quotes")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_id\": \"biz_xxxxxxxxxxxxxx\",\n  \"line_items\": [\n    {\n      \"plan_id\": \"plan_xxxxxxxxxxxxxx\",\n      \"quantity\": 1\n    }\n  ],\n  \"plan_id\": \"plan_xxxxxxxxxxxxxx\",\n  \"promo_code\": \"SHINE20\",\n  \"promo_code_id\": \"promo_xxxxxxxxxxxxxx\",\n  \"address\": {\n    \"city\": \"Austin\",\n    \"country\": \"US\",\n    \"line1\": \"1114 Bouldin Ave\",\n    \"line2\": \"Unit B\",\n    \"name\": \"Dana Whitfield\",\n    \"postal_code\": \"78704\",\n    \"state\": \"TX\"\n  },\n  \"ip_address\": \"203.0.113.7\",\n  \"shipping_address\": {\n    \"city\": \"<string>\",\n    \"country\": \"<string>\",\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"name\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"state\": \"<string>\"\n  },\n  \"tax_ids\": [\n    {\n      \"type\": \"eu_vat\",\n      \"value\": \"DE123456789\"\n    }\n  ]\n}"

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

{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "address": {
    "city": "Austin",
    "country": "US",
    "line1": "1114 Bouldin Ave",
    "line2": "Unit B",
    "name": "Dana Whitfield",
    "postal_code": "78704",
    "state": "TX"
  },
  "created_at": "2026-01-01T12:00:00.000Z",
  "currency": "usd",
  "discount": {
    "amount": "-1234.56",
    "currency": "usd",
    "decimals": 2,
    "display_decimals": 2
  },
  "expires_at": "2026-01-01T12:00:00.000Z",
  "id": "pq_xxxxxxxxxxxxxx",
  "line_items": [
    {
      "discount": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "plan_id": "plan_xxxxxxxxxxxxxx",
      "quantity": 1,
      "subtotal": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "tax_amount": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "total": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      }
    }
  ],
  "located_by": "address",
  "promo_code_id": null,
  "shipping_address": {
    "city": "Austin",
    "country": "US",
    "line1": "1114 Bouldin Ave",
    "line2": "Unit B",
    "name": "Dana Whitfield",
    "postal_code": "78704",
    "state": "TX"
  },
  "subtotal": {
    "amount": "-1234.56",
    "currency": "usd",
    "decimals": 2,
    "display_decimals": 2
  },
  "tax_amount": {
    "amount": "-1234.56",
    "currency": "usd",
    "decimals": 2,
    "display_decimals": 2
  },
  "tax_behavior": "exclusive",
  "tax_ids": [
    {
      "type": "us_ein",
      "value": "12-3456789"
    }
  ],
  "tax_status": "calculated",
  "total": {
    "amount": "-1234.56",
    "currency": "usd",
    "decimals": 2,
    "display_decimals": 2
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

Payment Quotes

Create Payment Quote

Prices a purchase the way a payment for it will be charged, for a buyer located by the shipping address, then the billing address, then the IP address you pass. The body is the PaymentInput a payment takes plus where the buyer is (address, shipping_address, tax_ids, ip_address); a seller that collects no tax on the purchase can be quoted without them. The purchase is priced from exactly what you send: no buyer is looked up, so no stored registration or purchase history applies. A quote is priced once, in the plans’ own currency, and expires at expires_at.

POST

payment_quotes

curl --request POST \
  --url https://api.whop.com/api/v1/payment_quotes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "line_items": [
    {
      "plan_id": "plan_xxxxxxxxxxxxxx",
      "quantity": 1
    }
  ],
  "plan_id": "plan_xxxxxxxxxxxxxx",
  "promo_code": "SHINE20",
  "promo_code_id": "promo_xxxxxxxxxxxxxx",
  "address": {
    "city": "Austin",
    "country": "US",
    "line1": "1114 Bouldin Ave",
    "line2": "Unit B",
    "name": "Dana Whitfield",
    "postal_code": "78704",
    "state": "TX"
  },
  "ip_address": "203.0.113.7",
  "shipping_address": {
    "city": "<string>",
    "country": "<string>",
    "line1": "<string>",
    "line2": "<string>",
    "name": "<string>",
    "postal_code": "<string>",
    "state": "<string>"
  },
  "tax_ids": [
    {
      "type": "eu_vat",
      "value": "DE123456789"
    }
  ]
}
'

import requests

url = "https://api.whop.com/api/v1/payment_quotes"

payload = {
    "account_id": "biz_xxxxxxxxxxxxxx",
    "line_items": [
        {
            "plan_id": "plan_xxxxxxxxxxxxxx",
            "quantity": 1
        }
    ],
    "plan_id": "plan_xxxxxxxxxxxxxx",
    "promo_code": "SHINE20",
    "promo_code_id": "promo_xxxxxxxxxxxxxx",
    "address": {
        "city": "Austin",
        "country": "US",
        "line1": "1114 Bouldin Ave",
        "line2": "Unit B",
        "name": "Dana Whitfield",
        "postal_code": "78704",
        "state": "TX"
    },
    "ip_address": "203.0.113.7",
    "shipping_address": {
        "city": "<string>",
        "country": "<string>",
        "line1": "<string>",
        "line2": "<string>",
        "name": "<string>",
        "postal_code": "<string>",
        "state": "<string>"
    },
    "tax_ids": [
        {
            "type": "eu_vat",
            "value": "DE123456789"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    account_id: 'biz_xxxxxxxxxxxxxx',
    line_items: [{plan_id: 'plan_xxxxxxxxxxxxxx', quantity: 1}],
    plan_id: 'plan_xxxxxxxxxxxxxx',
    promo_code: 'SHINE20',
    promo_code_id: 'promo_xxxxxxxxxxxxxx',
    address: {
      city: 'Austin',
      country: 'US',
      line1: '1114 Bouldin Ave',
      line2: 'Unit B',
      name: 'Dana Whitfield',
      postal_code: '78704',
      state: 'TX'
    },
    ip_address: '203.0.113.7',
    shipping_address: {
      city: '<string>',
      country: '<string>',
      line1: '<string>',
      line2: '<string>',
      name: '<string>',
      postal_code: '<string>',
      state: '<string>'
    },
    tax_ids: [{type: 'eu_vat', value: 'DE123456789'}]
  })
};

fetch('https://api.whop.com/api/v1/payment_quotes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/payment_quotes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'account_id' => 'biz_xxxxxxxxxxxxxx',
    'line_items' => [
        [
                'plan_id' => 'plan_xxxxxxxxxxxxxx',
                'quantity' => 1
        ]
    ],
    'plan_id' => 'plan_xxxxxxxxxxxxxx',
    'promo_code' => 'SHINE20',
    'promo_code_id' => 'promo_xxxxxxxxxxxxxx',
    'address' => [
        'city' => 'Austin',
        'country' => 'US',
        'line1' => '1114 Bouldin Ave',
        'line2' => 'Unit B',
        'name' => 'Dana Whitfield',
        'postal_code' => '78704',
        'state' => 'TX'
    ],
    'ip_address' => '203.0.113.7',
    'shipping_address' => [
        'city' => '<string>',
        'country' => '<string>',
        'line1' => '<string>',
        'line2' => '<string>',
        'name' => '<string>',
        'postal_code' => '<string>',
        'state' => '<string>'
    ],
    'tax_ids' => [
        [
                'type' => 'eu_vat',
                'value' => 'DE123456789'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.whop.com/api/v1/payment_quotes"

	payload := strings.NewReader("{\n  \"account_id\": \"biz_xxxxxxxxxxxxxx\",\n  \"line_items\": [\n    {\n      \"plan_id\": \"plan_xxxxxxxxxxxxxx\",\n      \"quantity\": 1\n    }\n  ],\n  \"plan_id\": \"plan_xxxxxxxxxxxxxx\",\n  \"promo_code\": \"SHINE20\",\n  \"promo_code_id\": \"promo_xxxxxxxxxxxxxx\",\n  \"address\": {\n    \"city\": \"Austin\",\n    \"country\": \"US\",\n    \"line1\": \"1114 Bouldin Ave\",\n    \"line2\": \"Unit B\",\n    \"name\": \"Dana Whitfield\",\n    \"postal_code\": \"78704\",\n    \"state\": \"TX\"\n  },\n  \"ip_address\": \"203.0.113.7\",\n  \"shipping_address\": {\n    \"city\": \"<string>\",\n    \"country\": \"<string>\",\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"name\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"state\": \"<string>\"\n  },\n  \"tax_ids\": [\n    {\n      \"type\": \"eu_vat\",\n      \"value\": \"DE123456789\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.whop.com/api/v1/payment_quotes")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_id\": \"biz_xxxxxxxxxxxxxx\",\n  \"line_items\": [\n    {\n      \"plan_id\": \"plan_xxxxxxxxxxxxxx\",\n      \"quantity\": 1\n    }\n  ],\n  \"plan_id\": \"plan_xxxxxxxxxxxxxx\",\n  \"promo_code\": \"SHINE20\",\n  \"promo_code_id\": \"promo_xxxxxxxxxxxxxx\",\n  \"address\": {\n    \"city\": \"Austin\",\n    \"country\": \"US\",\n    \"line1\": \"1114 Bouldin Ave\",\n    \"line2\": \"Unit B\",\n    \"name\": \"Dana Whitfield\",\n    \"postal_code\": \"78704\",\n    \"state\": \"TX\"\n  },\n  \"ip_address\": \"203.0.113.7\",\n  \"shipping_address\": {\n    \"city\": \"<string>\",\n    \"country\": \"<string>\",\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"name\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"state\": \"<string>\"\n  },\n  \"tax_ids\": [\n    {\n      \"type\": \"eu_vat\",\n      \"value\": \"DE123456789\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/payment_quotes")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_id\": \"biz_xxxxxxxxxxxxxx\",\n  \"line_items\": [\n    {\n      \"plan_id\": \"plan_xxxxxxxxxxxxxx\",\n      \"quantity\": 1\n    }\n  ],\n  \"plan_id\": \"plan_xxxxxxxxxxxxxx\",\n  \"promo_code\": \"SHINE20\",\n  \"promo_code_id\": \"promo_xxxxxxxxxxxxxx\",\n  \"address\": {\n    \"city\": \"Austin\",\n    \"country\": \"US\",\n    \"line1\": \"1114 Bouldin Ave\",\n    \"line2\": \"Unit B\",\n    \"name\": \"Dana Whitfield\",\n    \"postal_code\": \"78704\",\n    \"state\": \"TX\"\n  },\n  \"ip_address\": \"203.0.113.7\",\n  \"shipping_address\": {\n    \"city\": \"<string>\",\n    \"country\": \"<string>\",\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"name\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"state\": \"<string>\"\n  },\n  \"tax_ids\": [\n    {\n      \"type\": \"eu_vat\",\n      \"value\": \"DE123456789\"\n    }\n  ]\n}"

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

{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "address": {
    "city": "Austin",
    "country": "US",
    "line1": "1114 Bouldin Ave",
    "line2": "Unit B",
    "name": "Dana Whitfield",
    "postal_code": "78704",
    "state": "TX"
  },
  "created_at": "2026-01-01T12:00:00.000Z",
  "currency": "usd",
  "discount": {
    "amount": "-1234.56",
    "currency": "usd",
    "decimals": 2,
    "display_decimals": 2
  },
  "expires_at": "2026-01-01T12:00:00.000Z",
  "id": "pq_xxxxxxxxxxxxxx",
  "line_items": [
    {
      "discount": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "plan_id": "plan_xxxxxxxxxxxxxx",
      "quantity": 1,
      "subtotal": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "tax_amount": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "total": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      }
    }
  ],
  "located_by": "address",
  "promo_code_id": null,
  "shipping_address": {
    "city": "Austin",
    "country": "US",
    "line1": "1114 Bouldin Ave",
    "line2": "Unit B",
    "name": "Dana Whitfield",
    "postal_code": "78704",
    "state": "TX"
  },
  "subtotal": {
    "amount": "-1234.56",
    "currency": "usd",
    "decimals": 2,
    "display_decimals": 2
  },
  "tax_amount": {
    "amount": "-1234.56",
    "currency": "usd",
    "decimals": 2,
    "display_decimals": 2
  },
  "tax_behavior": "exclusive",
  "tax_ids": [
    {
      "type": "us_ein",
      "value": "12-3456789"
    }
  ],
  "tax_status": "calculated",
  "total": {
    "amount": "-1234.56",
    "currency": "usd",
    "decimals": 2,
    "display_decimals": 2
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

Authorizations

Authorization

string

header

required

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Headers

Idempotency-Key

string

A unique key that makes this request safe to retry. See Idempotent requests.

Maximum string length: 255

Example:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date

string

Pins the request to a dated API version.

Example:

"2026-09-29"

Body

application/json

The purchase: the account it belongs to, what is bought, and the promo code applied. The same shape prices a purchase and pays for it.

account_id

string

required

The account the purchase belongs to, prefixed biz_.

Example:

"biz_xxxxxxxxxxxxxx"

line_items

object[]

What the buyer is purchasing. One entry charges that variant; several entries form a cart, which requires every variant to be compatible, belong to this account, and use the same currency.

Required array length: 1 - 50 elements

Show child attributes

plan

object

The variant purchased, described by its attributes instead of an id: the variant with exactly these attributes is used, and one is created when none exists. Mutually exclusive with plan_id and line_items. Creating a variant requires plan:create; creating or updating a product requires the corresponding product permission.

Show child attributes

plan_id

string

The variant purchased, prefixed plan_. It must belong to the account. Mutually exclusive with plan and line_items.

Example:

"plan_xxxxxxxxxxxxxx"

The promo code as the buyer typed it, matched within the account regardless of case and surrounding spaces, as checkout matches it. It must be valid for the variant. Send it or promo_code_id, not both; an empty or whitespace-only string counts as not sent. A code the account does not have, or one that is no longer active, is refused before anything is written, with the error code promo_invalid.

Example:

"SHINE20"

An active promo code to apply, prefixed promo_. It must belong to the account and be valid for the variant. Send it or promo_code, not both.

Example:

"promo_xxxxxxxxxxxxxx"

address

object | null

The buyer's billing address. Where tax is calculated when no shipping address is given, and the address a tax registration belongs to. A seller that collects tax on this purchase needs the buyer located: provide a country here, on shipping_address, or an ip_address. Only the keys you supply are kept.

Show child attributes

ip_address

string | null

The buyer's IP address, when your server makes the call on their behalf. Locates the buyer when neither address carries a country. A quote located this way is an estimate (located_by is ip_address): quote again with the buyer's address.

Example:

"203.0.113.7"

shipping_address

object | null

Where physical goods ship. When present it is where tax is calculated; omit it for digital goods. Only the keys you supply are kept.

Show child attributes

tax_ids

object[] | null

The buyer's tax registration, for a business purchase. One entry. Prices the purchase as business-to-business where that applies (EU reverse charge, for one) and requires an address to belong to.

Maximum array length: 1

Show child attributes

Response

payment quote priced

account_id

string

required

The account the purchase is priced for, prefixed biz_.

Example:

"biz_xxxxxxxxxxxxxx"

address

object | null

required

The billing address the purchase was priced with, or null. Where tax was calculated when no shipping address was given, and the address the registration belongs to.

Show child attributes

created_at

string

required

When the quote was priced, as an ISO 8601 timestamp.

Example:

"2026-01-01T12:00:00.000Z"

currency

string

required

ISO currency the purchase is priced and charged in, lowercase — the variants' own currency.

Example:

"usd"

discount

object

required

What the promo code takes off. Zero without a code.

Show child attributes

expires_at

string

required

When the quote stops being chargeable, as an ISO 8601 timestamp. Quote again after it.

Example:

"2026-01-01T12:00:00.000Z"

string

required

Payment quote ID, prefixed pq_.

Example:

"pq_xxxxxxxxxxxxxx"

line_items

object[]

required

Show child attributes

located_by

enum<string> | null

required

Which location tax was calculated for: shipping_address when it carries a country, else the billing address when it does, else the buyer's ip_address. A quote located by ip_address is an estimate: quote again with the buyer's address. Null when nothing in the request located the buyer, which only a seller that collects no tax on this purchase is quoted without; tax_status is then not_applicable.

Available options:

shipping_address,

address,

ip_address,

null

Example:

"address"

The promo code the quote applied, prefixed promo_, or null.

Example:

null

shipping_address

object | null

required

The shipping address the purchase was priced with, or null. When present it is where tax was calculated.

Show child attributes

subtotal

object

required

The price of every line before the promo code, tax and fees.

Show child attributes

tax_amount

object

required

The tax owed on the purchase. Zero unless tax_status is calculated.

Show child attributes

tax_behavior

enum<string> | null

required

Whether tax is added on top of the price (exclusive) or already inside it (inclusive). Null when no tax was calculated.

Available options:

inclusive,

exclusive,

null

Example:

"exclusive"

tax_ids

object[]

required

Show child attributes

tax_status

enum<string>

required

calculated: every line was priced. not_applicable: this seller collects no tax on this purchase, so the quote owes none. unavailable: tax could not be priced — the provider did not answer, or this seller's tax setup cannot price a purchase here; quote again.

Available options:

calculated,

not_applicable,

unavailable

Example:

"calculated"

total

object

required

What the buyer pays: the subtotal less the discount, plus tax_amount when tax is added on top.

Show child attributes