tax-settings

Tax Settings

Run in Postman ❯

GET accounts/:account_id/tax_settings¶

Retrieve tax setting details associated with the current account.

Resource URL¶

https://ads-api.x.com/12/accounts/:account_id/tax_settings

Parameters¶

Name Description

account_id
required

The identifier for the leveraged account. Appears within the resource's path and is generally a required parameter for all Advertiser API requests excluding GET accounts. The specified account must be associated with the authenticated user.

Type: string

Example: 18ce54d4x5t

Example Request¶

GET https://ads-api.x.com/12/accounts/18ce54d4x5t/tax_settings

Example Response¶

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "tax_id": "GB896391250",
    "address_city": "London",
    "business_relationship": "SELF",
    "address_street1": "21 March St",
    "address_last_name": null,
    "address_company": "ABC, Inc.",
    "tax_category": "BUSINESS_WITH_VAT",
    "address_postal_code": "SW1A 1AA",
    "bill_to": "NOT_SET",
    "address_region": "London",
    "address_country": "GB",
    "address_first_name": null,
    "invoice_jurisdiction": "NOT_SET",
    "address_street2": null,
    "address_email": null
  }
}

PUT accounts/:account_id/tax_settings¶

Update the tax settings for the current account.

Resource URL¶

https://ads-api.x.com/12/accounts/:account_id/tax_settings

Parameters¶

Name	Description
account_id required	The identifier for the leveraged account. Appears within the resource's path and is generally a required parameter for all Advertiser API requests excluding GET accounts. The specified account must be associated with the authenticated user. Type: string Example: `18ce54d4x5t`
address_city optional	The city for the account owner's address. Type: string Example: `San Francisco`
address_country optional	The two-letter country code for the account owner's address. Type: string Example: `US`
address_email optional	The email associated with the account owner's address. Type: string Example: `api@mctestface.com`
address_first_name optional	The first name for the account owner's address. Type: string Example: `API`
address_last_name optional	The last name for the account owner's address. Type: string Example: `McTestface`
address_name optional	The company name for the account owner's address. Type: string Example: `ABC, Co.`
address_postal_code optional	The postal code for the account owner's address. Type: string Example: `94102`
address_region optional	The region for the account owner's address. Type: string Example: `California`
address_street1 optional	The street line for the account owner's address. Type: string Example: `21 March St`
address_street2 optional	The second street line for the account owner's address. Type: string Example: `Suite 99`
bill_to optional	The entity that is billed. Type: enum Possible values: `ADVERTISER`, `AGENCY`
business_relationship optional	Whether the account is owned by the advertiser or by the agency. Type: enum Possible values: `AGENCY`, `SELF`
client_address_city optional	The city for the advertiser's address. Set this when the ads account is owned by an agency. Type: string Example: `Toronto`
client_address_country optional	The two-letter country code for the advertiser's address. Set this when the ads account is owned by an agency. Type: string Example: `CA`
client_address_email optional	The email associated with the advertiser's address. Set this when the ads account is owned by an agency. Type: string Example: `ads@brand.com`
client_address_first_name optional	The first name for the advertiser's address. Set this when the ads account is owned by an agency. Type: string Example: `Brand`
client_address_last_name optional	The last name for the advertiser's address. Set this when the ads account is owned by an agency. Type: string Example: `Advertiser`
client_address_name optional	The company name for the advertiser's address. Set this when the ads account is owned by an agency. Type: string Example: `Brand, Inc.`
client_address_postal_code optional	The postal code for the advertiser's address. Set this when the ads account is owned by an agency. Type: string Example: `M5H 2N2`
client_address_region optional	The region for the advertiser's address. Set this when the ads account is owned by an agency. Type: string Example: `Ontario`
client_address_street1 optional	The street line for the advertiser's address. Set this when the ads account is owned by an agency. Type: string Example: `280 Queen St W`
client_address_street2 optional	The second street line for the advertiser's address. Set this when the ads account is owned by an agency. Type: string Example: `The 6`
invoice_jurisdiction optional	Invoice jurisdiction. Type: enum Possible values: `LOI_SAPIN`, `NONE`, `NOT_SET`
tax_category optional	Whether the taxation should be individual or business. Type: enum Possible values: `BUSINESS_NO_VAT`, `BUSINESS_WITH_VAT`, `INDIVIDUAL`
tax_exemption_id optional	VAT exemption ID. Type: sting Example: `12345`
tax_id optional	VAT registration ID. Type: string Possible values: `67890`

Example Request¶

PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/tax_settings?address_name=ABC, Co.

Example Response¶

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "address_name": "ABC Co."
    }
  },
  "data": {
    "tax_id": "GB896391250",
    "address_city": "London",
    "business_relationship": "SELF",
    "address_street1": "21 March St",
    "address_last_name": null,
    "address_company": "ABC, Co.",
    "tax_category": "BUSINESS_WITH_VAT",
    "address_postal_code": "SW1A 1AA",
    "bill_to": "NOT_SET",
    "address_region": "London",
    "address_country": "GB",
    "address_first_name": null,
    "invoice_jurisdiction": "NOT_SET",
    "address_street2": null,
    "address_email": null
  }
}