Retrieve a Customer tax ID
Retrieves the tax_id
object with the given identifier.
Parameters
No parameters.
Returns
Returns a tax_id
object if a valid identifier was provided.
{
"id": "txi_1MoC8zLkdIwHu7ixEhgWcHzJ",
"object": "tax_id",
"country": "DE",
"created": 1679431857,
"customer": "cus_NZKoSNZZ58qtO0",
"livemode": false,
"type": "eu_vat",
"value": "DE123456789",
"verification": {
"status": "pending",
"verified_address": null,
"verified_name": null
}
}
Retrieve a tax ID
Retrieves an account or customer tax_id
object.
Parameters
No parameters.
Returns
Returns a tax_id
object if a valid identifier was provided.
{
"id": "txi_1NuMB12eZvKYlo2CMecoWkZd",
"object": "tax_id",
"country": "DE",
"created": 123456789,
"customer": null,
"livemode": false,
"type": "eu_vat",
"value": "DE123456789",
"verification": null,
"owner": {
"type": "self",
"customer": null
}
}
List all Customer tax IDs
Returns a list of tax IDs for a customer.
Parameters
No parameters.
More parameters
- ending_
beforestring - limitinteger
- starting_
afterstring
Returns
A dictionary with a data
property that contains an array of up to limit
tax IDs, starting after tax ID starting_after
. Each entry in the array is a separate tax_id
object. If no more tax IDs are available, the resulting array will be empty. Raises an error if the customer ID is invalid.
{
"object": "list",
"url": "/v1/customers/cus_NZKoSNZZ58qtO0/tax_ids",
"has_more": false,
"data": [
{
"id": "txi_1MoC8zLkdIwHu7ixEhgWcHzJ",
"object": "tax_id",
"country": "DE",
"created": 1679431857,
"customer": "cus_NZKoSNZZ58qtO0",
"livemode": false,
"type": "eu_vat",
"value": "DE123456789",
"verification": {
"status": "pending",
"verified_address": null,
"verified_name": null
}
}
{...}
{...}
],
}
List all tax IDs
Returns a list of tax IDs.
Parameters
- ownerobject
The account or customer the tax ID belongs to. Defaults to
owner[type]=self
.
More parameters
- ending_
beforestring - limitinteger
- starting_
afterstring
Returns
A dictionary with a data
property that contains an array of up to limit
tax IDs, starting after tax ID starting_after
. Each entry in the array is a separate tax_id
object. If no more tax IDs are available, the resulting array will be empty.
{
"object": "list",
"url": "/v1/tax_ids",
"has_more": false,
"data": [
{
"id": "txi_1NuMB12eZvKYlo2CMecoWkZd",
"object": "tax_id",
"country": "DE",
"created": 123456789,
"customer": null,
"livemode": false,
"type": "eu_vat",
"value": "DE123456789",
"verification": null,
"owner": {
"type": "self",
"customer": null
}
}
{...}
{...}
],
}
Delete a Customer tax ID
Deletes an existing tax_id
object.
Parameters
No parameters.
Returns
Returns an object with a deleted parameter on success. If the tax_id
object does not exist, this call raises an error.
{
"id": "txi_1MoC8zLkdIwHu7ixEhgWcHzJ",
"object": "tax_id",
"deleted": true
}