Attach business tax details to a payment intent

curl --request POST \
  --url https://api.example.com/v1/sdk/payment-intents/{processorPaymentId}/business-details \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "isBusiness": true,
  "businessName": "<string>",
  "country": "<string>",
  "customerCity": "<string>",
  "customerCountry": "<string>",
  "customerLine1": "<string>",
  "customerLine2": "<string>",
  "customerName": "<string>",
  "customerPostalCode": "<string>",
  "customerRef": "<string>",
  "customerState": "<string>",
  "taxId": "<string>"
}
'

import requests

url = "https://api.example.com/v1/sdk/payment-intents/{processorPaymentId}/business-details"

payload = {
    "isBusiness": True,
    "businessName": "<string>",
    "country": "<string>",
    "customerCity": "<string>",
    "customerCountry": "<string>",
    "customerLine1": "<string>",
    "customerLine2": "<string>",
    "customerName": "<string>",
    "customerPostalCode": "<string>",
    "customerRef": "<string>",
    "customerState": "<string>",
    "taxId": "<string>"
}
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({
    isBusiness: true,
    businessName: '<string>',
    country: '<string>',
    customerCity: '<string>',
    customerCountry: '<string>',
    customerLine1: '<string>',
    customerLine2: '<string>',
    customerName: '<string>',
    customerPostalCode: '<string>',
    customerRef: '<string>',
    customerState: '<string>',
    taxId: '<string>'
  })
};

fetch('https://api.example.com/v1/sdk/payment-intents/{processorPaymentId}/business-details', 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.example.com/v1/sdk/payment-intents/{processorPaymentId}/business-details",
  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([
    'isBusiness' => true,
    'businessName' => '<string>',
    'country' => '<string>',
    'customerCity' => '<string>',
    'customerCountry' => '<string>',
    'customerLine1' => '<string>',
    'customerLine2' => '<string>',
    'customerName' => '<string>',
    'customerPostalCode' => '<string>',
    'customerRef' => '<string>',
    'customerState' => '<string>',
    'taxId' => '<string>'
  ]),
  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.example.com/v1/sdk/payment-intents/{processorPaymentId}/business-details"

	payload := strings.NewReader("{\n  \"isBusiness\": true,\n  \"businessName\": \"<string>\",\n  \"country\": \"<string>\",\n  \"customerCity\": \"<string>\",\n  \"customerCountry\": \"<string>\",\n  \"customerLine1\": \"<string>\",\n  \"customerLine2\": \"<string>\",\n  \"customerName\": \"<string>\",\n  \"customerPostalCode\": \"<string>\",\n  \"customerRef\": \"<string>\",\n  \"customerState\": \"<string>\",\n  \"taxId\": \"<string>\"\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.example.com/v1/sdk/payment-intents/{processorPaymentId}/business-details")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"isBusiness\": true,\n  \"businessName\": \"<string>\",\n  \"country\": \"<string>\",\n  \"customerCity\": \"<string>\",\n  \"customerCountry\": \"<string>\",\n  \"customerLine1\": \"<string>\",\n  \"customerLine2\": \"<string>\",\n  \"customerName\": \"<string>\",\n  \"customerPostalCode\": \"<string>\",\n  \"customerRef\": \"<string>\",\n  \"customerState\": \"<string>\",\n  \"taxId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/sdk/payment-intents/{processorPaymentId}/business-details")

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  \"isBusiness\": true,\n  \"businessName\": \"<string>\",\n  \"country\": \"<string>\",\n  \"customerCity\": \"<string>\",\n  \"customerCountry\": \"<string>\",\n  \"customerLine1\": \"<string>\",\n  \"customerLine2\": \"<string>\",\n  \"customerName\": \"<string>\",\n  \"customerPostalCode\": \"<string>\",\n  \"customerRef\": \"<string>\",\n  \"customerState\": \"<string>\",\n  \"taxId\": \"<string>\"\n}"

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

{
  "taxBreakdown": {
    "currency": "<string>",
    "inclusive": true,
    "subtotal": 123,
    "taxAmount": 123,
    "taxRate": 123,
    "total": 123,
    "treatment": "reverse_charge",
    "notRegistered": true,
    "taxType": "amusement_tax"
  }
}

POST

sdk

payment-intents

{processorPaymentId}

business-details

Attach business tax details to a payment intent

curl --request POST \
  --url https://api.example.com/v1/sdk/payment-intents/{processorPaymentId}/business-details \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "isBusiness": true,
  "businessName": "<string>",
  "country": "<string>",
  "customerCity": "<string>",
  "customerCountry": "<string>",
  "customerLine1": "<string>",
  "customerLine2": "<string>",
  "customerName": "<string>",
  "customerPostalCode": "<string>",
  "customerRef": "<string>",
  "customerState": "<string>",
  "taxId": "<string>"
}
'

import requests

url = "https://api.example.com/v1/sdk/payment-intents/{processorPaymentId}/business-details"

payload = {
    "isBusiness": True,
    "businessName": "<string>",
    "country": "<string>",
    "customerCity": "<string>",
    "customerCountry": "<string>",
    "customerLine1": "<string>",
    "customerLine2": "<string>",
    "customerName": "<string>",
    "customerPostalCode": "<string>",
    "customerRef": "<string>",
    "customerState": "<string>",
    "taxId": "<string>"
}
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({
    isBusiness: true,
    businessName: '<string>',
    country: '<string>',
    customerCity: '<string>',
    customerCountry: '<string>',
    customerLine1: '<string>',
    customerLine2: '<string>',
    customerName: '<string>',
    customerPostalCode: '<string>',
    customerRef: '<string>',
    customerState: '<string>',
    taxId: '<string>'
  })
};

fetch('https://api.example.com/v1/sdk/payment-intents/{processorPaymentId}/business-details', 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.example.com/v1/sdk/payment-intents/{processorPaymentId}/business-details",
  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([
    'isBusiness' => true,
    'businessName' => '<string>',
    'country' => '<string>',
    'customerCity' => '<string>',
    'customerCountry' => '<string>',
    'customerLine1' => '<string>',
    'customerLine2' => '<string>',
    'customerName' => '<string>',
    'customerPostalCode' => '<string>',
    'customerRef' => '<string>',
    'customerState' => '<string>',
    'taxId' => '<string>'
  ]),
  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.example.com/v1/sdk/payment-intents/{processorPaymentId}/business-details"

	payload := strings.NewReader("{\n  \"isBusiness\": true,\n  \"businessName\": \"<string>\",\n  \"country\": \"<string>\",\n  \"customerCity\": \"<string>\",\n  \"customerCountry\": \"<string>\",\n  \"customerLine1\": \"<string>\",\n  \"customerLine2\": \"<string>\",\n  \"customerName\": \"<string>\",\n  \"customerPostalCode\": \"<string>\",\n  \"customerRef\": \"<string>\",\n  \"customerState\": \"<string>\",\n  \"taxId\": \"<string>\"\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.example.com/v1/sdk/payment-intents/{processorPaymentId}/business-details")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"isBusiness\": true,\n  \"businessName\": \"<string>\",\n  \"country\": \"<string>\",\n  \"customerCity\": \"<string>\",\n  \"customerCountry\": \"<string>\",\n  \"customerLine1\": \"<string>\",\n  \"customerLine2\": \"<string>\",\n  \"customerName\": \"<string>\",\n  \"customerPostalCode\": \"<string>\",\n  \"customerRef\": \"<string>\",\n  \"customerState\": \"<string>\",\n  \"taxId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/sdk/payment-intents/{processorPaymentId}/business-details")

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  \"isBusiness\": true,\n  \"businessName\": \"<string>\",\n  \"country\": \"<string>\",\n  \"customerCity\": \"<string>\",\n  \"customerCountry\": \"<string>\",\n  \"customerLine1\": \"<string>\",\n  \"customerLine2\": \"<string>\",\n  \"customerName\": \"<string>\",\n  \"customerPostalCode\": \"<string>\",\n  \"customerRef\": \"<string>\",\n  \"customerState\": \"<string>\",\n  \"taxId\": \"<string>\"\n}"

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

{
  "taxBreakdown": {
    "currency": "<string>",
    "inclusive": true,
    "subtotal": 123,
    "taxAmount": 123,
    "taxRate": 123,
    "total": 123,
    "treatment": "reverse_charge",
    "notRegistered": true,
    "taxType": "amusement_tax"
  }
}

Authorizations

Authorization

string

header

required

Provider secret API key (sk_live_… / sk_test_…) supplied as a Bearer token.

Path Parameters

processorPaymentId

string

required

Stripe payment intent ID (pi_…)

Body

application/json

isBusiness

boolean

required

Whether the purchase is on behalf of a business

businessName

string

Legal business name

country

string

ISO 3166-1 alpha-2 country code

customerCity

string

Billing city

customerCountry

string

ISO 3166-1 alpha-2 billing country (non-business consumers)

customerLine1

string

Billing address line 1

customerLine2

string

Billing address line 2

customerName

string

Customer full name

Maximum string length: 100

customerPostalCode

string

Billing postal code (required by Stripe Tax for US)

customerRef

string

Customer reference to persist business tax details on the customer record. Only honored by the payment-intent business-details endpoint; ignored on the checkout-session endpoint.

customerState

string

Billing state/region

taxId

string

Tax / VAT identification number

taxIdType

enum<string>

Tax ID type

Available options:

ae_trn,

al_tin,

am_tin,

ao_tin,

au_abn,

aw_tin,

az_tin,

ba_tin,

bb_tin,

bd_bin,

bf_ifu,

bh_vat,

bj_ifu,

bs_tin,

by_tin,

ca_gst_hst,

cd_nif,

ch_vat,

cl_tin,

cm_niu,

co_nit,

cr_tin,

cv_nif,

ec_ruc,

eg_tin,

et_tin,

eu_vat,

gb_vat,

ge_vat,

gn_nif,

hk_br,

id_npwp,

in_gst,

is_vat,

jp_trn,

ke_pin,

kg_tin,

kh_tin,

kr_brn,

kz_bin,

la_tin,

li_vat,

lk_vat,

ma_vat,

md_vat,

me_pib,

mk_vat,

mr_nif,

mx_rfc,

my_sst,

ng_tin,

no_vat,

np_pan,

nz_gst,

om_vat,

pe_ruc,

ph_tin,

rs_pib,

ru_inn,

sa_vat,

sg_gst,

sn_ninea,

sr_fin,

th_vat,

tj_tin,

tr_tin,

tw_vat,

tz_vat,

ua_vat,

ug_tin,

us_ein,

uy_ruc,

uz_vat,

vn_tin,

za_vat,

zm_tin,

zw_tin

Response

Business details applied and tax breakdown returned

taxBreakdown

object

required

Calculated tax breakdown

Show child attributes

⌘I

Activation

Auto Recharge

Checkout Sessions

Credits

Customers

Limits

Merchant

Meter Events

Payment Intents

Payment Methods

Platform Config

Products

Plans

Purchases

Usage

User Info

Webhooks

Attach business tax details to a payment intent

Authorizations

Path Parameters

Body

Response