Retrieve settings

Changed on

Retrieves Tax Settings for a merchant.

get/v1/tax/settings

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/tax/settings
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Query parameters

expandstring[]

Specifies which fields in the response should be expanded.

Request body application/x-www-form-urlencoded

object required

Response

Successful response.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

object'tax.settings' required

String representing the object's type. Objects of the same type share the same value.

status'active' | 'pending' required

Whether these settings have the information Stripe Tax needs to calculate tax. It doesn't reflect whether your integration is ready to collect tax.

Changes

  • c113b1939b8fRevision changes
    • info

      added the optional property ////// to the response with the status

  • 7b8f614372caRevision changes
    • info

      added the optional property ////////// to the response with the status

Some revisions have not been checked yet.