Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Reserves
Fraud
Issuing
Terminal
Treasury
Payment Records
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Privacy
Webhooks

Create a registration

Creates a new Tax Registration object.

Parameters

  • active_fromstring | timestampRequired

    Time at which the Tax Registration becomes active. It can be either now to indicate the current time, or a future timestamp measured in seconds since the Unix epoch.

  • countrystringRequired

    Two-letter country code (ISO 3166-1 alpha-2).

  • country_optionsobjectRequired

    Specific options for a registration in the specified country.

  • expires_attimestamp

    If set, the Tax Registration stops being active at this time. If not set, the Tax Registration will be active indefinitely. Timestamp measured in seconds since the Unix epoch.

Returns

A Tax Registration object.

POST /v1/tax/registrations
curl https://api.stripe.com/v1/tax/registrations \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d country=US \
  -d "country_options[us][state]"=CA \
  -d "country_options[us][type]"=state_sales_tax \
  -d active_from=now
Response
{
  "id": "taxreg_NkyGPRPytKq66j",
  "object": "tax.registration",
  "active_from": 1682036640,
  "country": "US",
  "country_options": {
    "us": {
      "state": "CA",
      "type": "state_sales_tax"
    }
  },
  "created": 1682006400,
  "expires_at": null,
  "livemode": false,
  "status": "active"
}

Update a registration

Updates an existing Tax Registration object.

A registration cannot be deleted after it has been created. If you wish to end a registration you may do so by setting expires_at.

Parameters

  • active_fromstring | timestamp

    Time at which the registration becomes active. It can be either now to indicate the current time, or a timestamp measured in seconds since the Unix epoch.

  • expires_atstring | timestamp

    If set, the registration stops being active at this time. If not set, the registration will be active indefinitely. It can be either now to indicate the current time, or a timestamp measured in seconds since the Unix epoch.

Returns

A Tax Registration object.

POST /v1/tax/registrations/:id
curl https://api.stripe.com/v1/tax/registrations/taxreg_NkyGPRPytKq66j \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d expires_at=now
Response
{
  "id": "taxreg_NkyGPRPytKq66j",
  "object": "tax.registration",
  "active_from": 1683036640,
  "country": "US",
  "country_options": {
    "us": {
      "state": "CA",
      "type": "state_sales_tax"
    }
  },
  "created": 1682006400,
  "expires_at": 1684072000,
  "livemode": false,
  "status": "active"
}

Retrieve a registration

Returns a Tax Registration object.

Parameters

No parameters.

Returns

A Tax Registration object.

GET /v1/tax/registrations/:id
curl https://api.stripe.com/v1/tax/registrations/taxreg_NkyGPRPytKq66j \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:"
Response
{
  "id": "taxreg_NkyGPRPytKq66j",
  "object": "tax.registration",
  "active_from": 1682036640,
  "country": "US",
  "country_options": {
    "us": {
      "state": "CA",
      "type": "state_sales_tax"
    }
  },
  "created": 1682006400,
  "expires_at": null,
  "livemode": false,
  "status": "active"
}

List registrations

Returns a list of Tax Registration objects.

Parameters

  • statusenum

    The status of the Tax Registration.

    Possible enum values
    active

    Return all active Tax Registrations.

    all

    Return all Tax Registrations (default).

    expired

    Return all expired Tax Registrations.

    scheduled

    Return all scheduled Tax Registrations.

More parameters

  • ending_beforestring

  • limitinteger

  • starting_afterstring

Returns

A list of Tax Registration objects.

GET /v1/tax/registrations
curl -G https://api.stripe.com/v1/tax/registrations \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d limit=3
Response
{
  "object": "list",
  "url": "/v1/tax/registrations",
  "has_more": false,
  "data": [
    {
      "id": "taxreg_NkyGPRPytKq66j",
      "object": "tax.registration",
      "active_from": 1682036640,
      "country": "US",
      "country_options": {
        "us": {
          "state": "CA",
          "type": "state_sales_tax"
        }
      },
      "created": 1682006400,
      "expires_at": null,
      "livemode": false,
      "status": "active"
    }
  ]
}