Stripe: Create a registration
Stripe tax.postTaxRegistrations: arguments, response, policy and SDK examples.
← Tax operations · Get started
Operation stripe.posttaxregistrations
Provider route: POST /v1/tax/registrations. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/stripe with npm, or alter-sdk-stripe with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { StripeIntegration } from "@alter-ai/stripe";
async function execute(input: Parameters<StripeIntegration["tax"]["postTaxRegistrations"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new StripeIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.tax.postTaxRegistrations(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_stripe import StripeIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = StripeIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.tax.post_tax_registrations(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
headers | object | Optional | Additional keys: not allowed |
headers.Idempotency-Key | string | Optional | Minimum length: 1 Maximum length: 255 |
body | object | Required within parent | Additional keys: not allowed |
body.active_from | JSON | Required within parent | 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. |
body.active_from (anyOf 1) | string | Alternative | One of: now Maximum length: 5000 |
body.active_from (anyOf 2) | integer | Alternative | Format: unix-time |
body.country | string | Required within parent | Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). Maximum length: 5000 |
body.country_options | object | Required within parent | Specific options for a registration in the specified `country`. |
body.country_options.ae | object | Optional | |
body.country_options.ae.standard | object | Optional | |
body.country_options.ae.standard.place_of_supply_scheme | string | Optional | One of: inbound_goods, standard |
body.country_options.ae.type | string | Required within parent | One of: standard |
body.country_options.al | object | Optional | |
body.country_options.al.standard | object | Optional | |
body.country_options.al.standard.place_of_supply_scheme | string | Optional | One of: inbound_goods, standard |
body.country_options.al.type | string | Required within parent | One of: standard |
body.country_options.am | object | Optional | |
body.country_options.am.type | string | Required within parent | One of: simplified |
body.country_options.ao | object | Optional | |
body.country_options.ao.standard | object | Optional | |
body.country_options.ao.standard.place_of_supply_scheme | string | Optional | One of: inbound_goods, standard |
body.country_options.ao.type | string | Required within parent | One of: standard |
body.country_options.at | object | Optional | |
body.country_options.at.standard | object | Optional | |
body.country_options.at.standard.place_of_supply_scheme | string | Required within parent | One of: inbound_goods, small_seller, standard |
body.country_options.at.type | string | Required within parent | One of: ioss, oss_non_union, oss_union, standard |
body.country_options.au | object | Optional | |
body.country_options.au.standard | object | Optional | |
body.country_options.au.standard.place_of_supply_scheme | string | Optional | One of: inbound_goods, standard |
body.country_options.au.type | string | Required within parent | One of: standard |
body.country_options.aw | object | Optional | |
body.country_options.aw.standard | object | Optional | |
body.country_options.aw.standard.place_of_supply_scheme | string | Optional | One of: inbound_goods, standard |
body.country_options.aw.type | string | Required within parent | One of: standard |
body.country_options.az | object | Optional | |
body.country_options.az.type | string | Required within parent | One of: simplified |
body.country_options.ba | object | Optional | |
body.country_options.ba.standard | object | Optional | |
body.country_options.ba.standard.place_of_supply_scheme | string | Optional | One of: inbound_goods, standard |
body.country_options.ba.type | string | Required within parent | One of: standard |
body.country_options.bb | object | Optional | |
body.country_options.bb.standard | object | Optional | |
body.country_options.bb.standard.place_of_supply_scheme | string | Optional | One of: inbound_goods, standard |
body.country_options.bb.type | string | Required within parent | One of: standard |
body.country_options.bd | object | Optional | |
body.country_options.bd.standard | object | Optional | |
body.country_options.bd.standard.place_of_supply_scheme | string | Optional | One of: inbound_goods, standard |
body.country_options.bd.type | string | Required within parent | One of: standard |
body.country_options.be | object | Optional | |
body.country_options.be.standard | object | Optional | |
body.country_options.be.standard.place_of_supply_scheme | string | Required within parent | One of: inbound_goods, small_seller, standard |
body.country_options.be.type | string | Required within parent | One of: ioss, oss_non_union, oss_union, standard |
body.country_options.bf | object | Optional | |
body.country_options.bf.standard | object | Optional | |
body.country_options.bf.standard.place_of_supply_scheme | string | Optional | One of: inbound_goods, standard |
body.country_options.bf.type | string | Required within parent | One of: standard |
body.country_options.bg | object | Optional | |
body.country_options.bg.standard | object | Optional | |
body.country_options.bg.standard.place_of_supply_scheme | string | Required within parent | One of: inbound_goods, small_seller, standard |
body.country_options.bg.type | string | Required within parent | One of: ioss, oss_non_union, oss_union, standard |
body.country_options.bh | object | Optional | |
body.country_options.bh.standard | object | Optional | |
body.country_options.bh.standard.place_of_supply_scheme | string | Optional | One of: inbound_goods, standard |
body.country_options.bh.type | string | Required within parent | One of: standard |
body.country_options.bj | object | Optional | |
body.country_options.bj.type | string | Required within parent | One of: simplified |
body.country_options.bs | object | Optional | |
body.country_options.bs.standard | object | Optional | |
body.country_options.bs.standard.place_of_supply_scheme | string | Optional | One of: inbound_goods, standard |
body.country_options.bs.type | string | Required within parent | One of: standard |
body.country_options.by | object | Optional | |
body.country_options.by.type | string | Required within parent | One of: simplified |
body.country_options.ca | object | Optional | |
body.country_options.ca.province_standard | object | Optional | |
body.country_options.ca.province_standard.province | string | Required within parent | Maximum length: 5000 |
body.country_options.ca.type | string | Required within parent | One of: province_standard, simplified, standard |
body.country_options.cd | object | Optional | |
body.country_options.cd.standard | object | Optional | |
body.country_options.cd.standard.place_of_supply_scheme | string | Optional | One of: inbound_goods, standard |
body.country_options.cd.type | string | Required within parent | One of: standard |
body.country_options.ch | object | Optional | |
body.country_options.ch.standard | object | Optional | |
body.country_options.ch.standard.place_of_supply_scheme | string | Optional | One of: inbound_goods, standard |
body.country_options.ch.type | string | Required within parent | One of: standard |
body.country_options.cl | object | Optional | |
body.country_options.cl.type | string | Required within parent | One of: simplified |
body.country_options.cm | object | Optional | |
body.country_options.cm.type | string | Required within parent | One of: simplified |
body.country_options.co | object | Optional | |
body.country_options.co.type | string | Required within parent | One of: simplified |
body.country_options.cr | object | Optional | |
body.country_options.cr.type | string | Required within parent | One of: simplified |
body.country_options.cv | object | Optional | |
body.country_options.cv.type | string | Required within parent | One of: simplified |
body.country_options.cy | object | Optional | |
body.country_options.cy.standard | object | Optional | |
body.country_options.cy.standard.place_of_supply_scheme | string | Required within parent | One of: inbound_goods, small_seller, standard |
body.country_options.cy.type | string | Required within parent | One of: ioss, oss_non_union, oss_union, standard |
body.country_options.cz | object | Optional | |
body.country_options.cz.standard | object | Optional | |
body.country_options.cz.standard.place_of_supply_scheme | string | Required within parent | One of: inbound_goods, small_seller, standard |
body.country_options.cz.type | string | Required within parent | One of: ioss, oss_non_union, oss_union, standard |
body.country_options.de | object | Optional | |
body.country_options.de.standard | object | Optional | |
body.country_options.de.standard.place_of_supply_scheme | string | Required within parent | One of: inbound_goods, small_seller, standard |
body.country_options.de.type | string | Required within parent | One of: ioss, oss_non_union, oss_union, standard |
body.country_options.dk | object | Optional | |
body.country_options.dk.standard | object | Optional | |
body.country_options.dk.standard.place_of_supply_scheme | string | Required within parent | One of: inbound_goods, small_seller, standard |
body.country_options.dk.type | string | Required within parent | One of: ioss, oss_non_union, oss_union, standard |
body.country_options.ec | object | Optional | |
body.country_options.ec.type | string | Required within parent | One of: simplified |
body.country_options.ee | object | Optional | |
body.country_options.ee.standard | object | Optional | |
body.country_options.ee.standard.place_of_supply_scheme | string | Required within parent | One of: inbound_goods, small_seller, standard |
body.country_options.ee.type | string | Required within parent | One of: ioss, oss_non_union, oss_union, standard |
body.country_options.eg | object | Optional | |
body.country_options.eg.type | string | Required within parent | One of: simplified |
body.country_options.es | object | Optional | |
body.country_options.es.standard | object | Optional | |
body.country_options.es.standard.place_of_supply_scheme | string | Required within parent | One of: inbound_goods, small_seller, standard |
body.country_options.es.type | string | Required within parent | One of: ioss, oss_non_union, oss_union, standard |
body.country_options.et | object | Optional | |
body.country_options.et.standard | object | Optional | |
body.country_options.et.standard.place_of_supply_scheme | string | Optional | One of: inbound_goods, standard |
body.country_options.et.type | string | Required within parent | One of: standard |
body.country_options.fi | object | Optional | |
body.country_options.fi.standard | object | Optional | |
body.country_options.fi.standard.place_of_supply_scheme | string | Required within parent | One of: inbound_goods, small_seller, standard |
body.country_options.fi.type | string | Required within parent | One of: ioss, oss_non_union, oss_union, standard |
body.country_options.fr | object | Optional | |
body.country_options.fr.standard | object | Optional | |
body.country_options.fr.standard.place_of_supply_scheme | string | Required within parent | One of: inbound_goods, small_seller, standard |
body.country_options.fr.type | string | Required within parent | One of: ioss, oss_non_union, oss_union, standard |
body.country_options.gb | object | Optional | |
body.country_options.gb.standard | object | Optional | |
body.country_options.gb.standard.place_of_supply_scheme | string | Optional | One of: inbound_goods, standard |
body.country_options.gb.type | string | Required within parent | One of: standard |
body.country_options.ge | object | Optional | |
body.country_options.ge.type | string | Required within parent | One of: simplified |
body.country_options.gn | object | Optional | |
body.country_options.gn.standard | object | Optional | |
body.country_options.gn.standard.place_of_supply_scheme | string | Optional | One of: inbound_goods, standard |
body.country_options.gn.type | string | Required within parent | One of: standard |
body.country_options.gr | object | Optional | |
body.country_options.gr.standard | object | Optional | |
body.country_options.gr.standard.place_of_supply_scheme | string | Required within parent | One of: inbound_goods, small_seller, standard |
body.country_options.gr.type | string | Required within parent | One of: ioss, oss_non_union, oss_union, standard |
body.country_options.hr | object | Optional | |
body.country_options.hr.standard | object | Optional | |
body.country_options.hr.standard.place_of_supply_scheme | string | Required within parent | One of: inbound_goods, small_seller, standard |
body.country_options.hr.type | string | Required within parent | One of: ioss, oss_non_union, oss_union, standard |
body.country_options.hu | object | Optional | |
body.country_options.hu.standard | object | Optional | |
body.country_options.hu.standard.place_of_supply_scheme | string | Required within parent | One of: inbound_goods, small_seller, standard |
body.country_options.hu.type | string | Required within parent | One of: ioss, oss_non_union, oss_union, standard |
body.country_options.id | object | Optional | |
body.country_options.id.type | string | Required within parent | One of: simplified |
body.country_options.ie | object | Optional | |
body.country_options.ie.standard | object | Optional | |
body.country_options.ie.standard.place_of_supply_scheme | string | Required within parent | One of: inbound_goods, small_seller, standard |
body.country_options.ie.type | string | Required within parent | One of: ioss, oss_non_union, oss_union, standard |
body.country_options.in | object | Optional | |
body.country_options.in.type | string | Required within parent | One of: simplified |
body.country_options.is | object | Optional | |
body.country_options.is.standard | object | Optional | |
body.country_options.is.standard.place_of_supply_scheme | string | Optional | One of: inbound_goods, standard |
body.country_options.is.type | string | Required within parent | One of: standard |
body.country_options.it | object | Optional | |
body.country_options.it.standard | object | Optional | |
body.country_options.it.standard.place_of_supply_scheme | string | Required within parent | One of: inbound_goods, small_seller, standard |
body.country_options.it.type | string | Required within parent | One of: ioss, oss_non_union, oss_union, standard |
body.country_options.jp | object | Optional | |
body.country_options.jp.standard | object | Optional | |
body.country_options.jp.standard.place_of_supply_scheme | string | Optional | One of: inbound_goods, standard |
body.country_options.jp.type | string | Required within parent | One of: standard |
body.country_options.ke | object | Optional | |
body.country_options.ke.type | string | Required within parent | One of: simplified |
body.country_options.kg | object | Optional | |
body.country_options.kg.type | string | Required within parent | One of: simplified |
body.country_options.kh | object | Optional | |
body.country_options.kh.type | string | Required within parent | One of: simplified |
body.country_options.kr | object | Optional | |
body.country_options.kr.type | string | Required within parent | One of: simplified |
body.country_options.kz | object | Optional | |
body.country_options.kz.type | string | Required within parent | One of: simplified |
body.country_options.la | object | Optional | |
body.country_options.la.type | string | Required within parent | One of: simplified |
body.country_options.lk | object | Optional | |
body.country_options.lk.type | string | Required within parent | One of: simplified |
body.country_options.lt | object | Optional | |
body.country_options.lt.standard | object | Optional | |
body.country_options.lt.standard.place_of_supply_scheme | string | Required within parent | One of: inbound_goods, small_seller, standard |
body.country_options.lt.type | string | Required within parent | One of: ioss, oss_non_union, oss_union, standard |
body.country_options.lu | object | Optional | |
body.country_options.lu.standard | object | Optional | |
body.country_options.lu.standard.place_of_supply_scheme | string | Required within parent | One of: inbound_goods, small_seller, standard |
body.country_options.lu.type | string | Required within parent | One of: ioss, oss_non_union, oss_union, standard |
body.country_options.lv | object | Optional | |
body.country_options.lv.standard | object | Optional | |
body.country_options.lv.standard.place_of_supply_scheme | string | Required within parent | One of: inbound_goods, small_seller, standard |
body.country_options.lv.type | string | Required within parent | One of: ioss, oss_non_union, oss_union, standard |
body.country_options.ma | object | Optional | |
body.country_options.ma.type | string | Required within parent | One of: simplified |
body.country_options.md | object | Optional | |
body.country_options.md.type | string | Required within parent | One of: simplified |
body.country_options.me | object | Optional | |
body.country_options.me.standard | object | Optional | |
body.country_options.me.standard.place_of_supply_scheme | string | Optional | One of: inbound_goods, standard |
body.country_options.me.type | string | Required within parent | One of: standard |
body.country_options.mk | object | Optional | |
body.country_options.mk.standard | object | Optional | |
body.country_options.mk.standard.place_of_supply_scheme | string | Optional | One of: inbound_goods, standard |
body.country_options.mk.type | string | Required within parent | One of: standard |
body.country_options.mr | object | Optional | |
body.country_options.mr.standard | object | Optional | |
body.country_options.mr.standard.place_of_supply_scheme | string | Optional | One of: inbound_goods, standard |
body.country_options.mr.type | string | Required within parent | One of: standard |
body.country_options.mt | object | Optional | |
body.country_options.mt.standard | object | Optional | |
body.country_options.mt.standard.place_of_supply_scheme | string | Required within parent | One of: inbound_goods, small_seller, standard |
body.country_options.mt.type | string | Required within parent | One of: ioss, oss_non_union, oss_union, standard |
body.country_options.mx | object | Optional | |
body.country_options.mx.type | string | Required within parent | One of: simplified |
body.country_options.my | object | Optional | |
body.country_options.my.type | string | Required within parent | One of: simplified |
body.country_options.ng | object | Optional | |
body.country_options.ng.type | string | Required within parent | One of: simplified |
body.country_options.nl | object | Optional | |
body.country_options.nl.standard | object | Optional | |
body.country_options.nl.standard.place_of_supply_scheme | string | Required within parent | One of: inbound_goods, small_seller, standard |
body.country_options.nl.type | string | Required within parent | One of: ioss, oss_non_union, oss_union, standard |
body.country_options.no | object | Optional | |
body.country_options.no.standard | object | Optional | |
body.country_options.no.standard.place_of_supply_scheme | string | Optional | One of: inbound_goods, standard |
body.country_options.no.type | string | Required within parent | One of: standard |
body.country_options.np | object | Optional | |
body.country_options.np.type | string | Required within parent | One of: simplified |
body.country_options.nz | object | Optional | |
body.country_options.nz.standard | object | Optional | |
body.country_options.nz.standard.place_of_supply_scheme | string | Optional | One of: inbound_goods, standard |
body.country_options.nz.type | string | Required within parent | One of: standard |
body.country_options.om | object | Optional | |
body.country_options.om.standard | object | Optional | |
body.country_options.om.standard.place_of_supply_scheme | string | Optional | One of: inbound_goods, standard |
body.country_options.om.type | string | Required within parent | One of: standard |
body.country_options.pe | object | Optional | |
body.country_options.pe.type | string | Required within parent | One of: simplified |
body.country_options.ph | object | Optional | |
body.country_options.ph.type | string | Required within parent | One of: simplified |
body.country_options.pl | object | Optional | |
body.country_options.pl.standard | object | Optional | |
body.country_options.pl.standard.place_of_supply_scheme | string | Required within parent | One of: inbound_goods, small_seller, standard |
body.country_options.pl.type | string | Required within parent | One of: ioss, oss_non_union, oss_union, standard |
body.country_options.pt | object | Optional | |
body.country_options.pt.standard | object | Optional | |
body.country_options.pt.standard.place_of_supply_scheme | string | Required within parent | One of: inbound_goods, small_seller, standard |
body.country_options.pt.type | string | Required within parent | One of: ioss, oss_non_union, oss_union, standard |
body.country_options.ro | object | Optional | |
body.country_options.ro.standard | object | Optional | |
body.country_options.ro.standard.place_of_supply_scheme | string | Required within parent | One of: inbound_goods, small_seller, standard |
body.country_options.ro.type | string | Required within parent | One of: ioss, oss_non_union, oss_union, standard |
body.country_options.rs | object | Optional | |
body.country_options.rs.standard | object | Optional | |
body.country_options.rs.standard.place_of_supply_scheme | string | Optional | One of: inbound_goods, standard |
body.country_options.rs.type | string | Required within parent | One of: standard |
body.country_options.ru | object | Optional | |
body.country_options.ru.type | string | Required within parent | One of: simplified |
body.country_options.sa | object | Optional | |
body.country_options.sa.type | string | Required within parent | One of: simplified |
body.country_options.se | object | Optional | |
body.country_options.se.standard | object | Optional | |
body.country_options.se.standard.place_of_supply_scheme | string | Required within parent | One of: inbound_goods, small_seller, standard |
body.country_options.se.type | string | Required within parent | One of: ioss, oss_non_union, oss_union, standard |
body.country_options.sg | object | Optional | |
body.country_options.sg.standard | object | Optional | |
body.country_options.sg.standard.place_of_supply_scheme | string | Optional | One of: inbound_goods, standard |
body.country_options.sg.type | string | Required within parent | One of: standard |
body.country_options.si | object | Optional | |
body.country_options.si.standard | object | Optional | |
body.country_options.si.standard.place_of_supply_scheme | string | Required within parent | One of: inbound_goods, small_seller, standard |
body.country_options.si.type | string | Required within parent | One of: ioss, oss_non_union, oss_union, standard |
body.country_options.sk | object | Optional | |
body.country_options.sk.standard | object | Optional | |
body.country_options.sk.standard.place_of_supply_scheme | string | Required within parent | One of: inbound_goods, small_seller, standard |
body.country_options.sk.type | string | Required within parent | One of: ioss, oss_non_union, oss_union, standard |
body.country_options.sn | object | Optional | |
body.country_options.sn.type | string | Required within parent | One of: simplified |
body.country_options.sr | object | Optional | |
body.country_options.sr.standard | object | Optional | |
body.country_options.sr.standard.place_of_supply_scheme | string | Optional | One of: inbound_goods, standard |
body.country_options.sr.type | string | Required within parent | One of: standard |
body.country_options.th | object | Optional | |
body.country_options.th.type | string | Required within parent | One of: simplified |
body.country_options.tj | object | Optional | |
body.country_options.tj.type | string | Required within parent | One of: simplified |
body.country_options.tr | object | Optional | |
body.country_options.tr.type | string | Required within parent | One of: simplified |
body.country_options.tw | object | Optional | |
body.country_options.tw.type | string | Required within parent | One of: simplified |
body.country_options.tz | object | Optional | |
body.country_options.tz.type | string | Required within parent | One of: simplified |
body.country_options.ua | object | Optional | |
body.country_options.ua.type | string | Required within parent | One of: simplified |
body.country_options.ug | object | Optional | |
body.country_options.ug.type | string | Required within parent | One of: simplified |
body.country_options.us | object | Optional | |
body.country_options.us.admissions_tax | object | Optional | |
body.country_options.us.admissions_tax.jurisdiction | string | Required within parent | Maximum length: 5000 |
body.country_options.us.attendance_tax | object | Optional | |
body.country_options.us.attendance_tax.jurisdiction | string | Required within parent | Maximum length: 5000 |
body.country_options.us.entertainment_tax | object | Optional | |
body.country_options.us.entertainment_tax.jurisdiction | string | Required within parent | Maximum length: 5000 |
body.country_options.us.gross_receipts_tax | object | Optional | |
body.country_options.us.gross_receipts_tax.jurisdiction | string | Required within parent | Maximum length: 5000 |
body.country_options.us.hospitality_tax | object | Optional | |
body.country_options.us.hospitality_tax.jurisdiction | string | Required within parent | Maximum length: 5000 |
body.country_options.us.local_amusement_tax | object | Optional | |
body.country_options.us.local_amusement_tax.jurisdiction | string | Required within parent | Maximum length: 5000 |
body.country_options.us.local_lease_tax | object | Optional | |
body.country_options.us.local_lease_tax.jurisdiction | string | Required within parent | Maximum length: 5000 |
body.country_options.us.luxury_tax | object | Optional | |
body.country_options.us.luxury_tax.jurisdiction | string | Required within parent | Maximum length: 5000 |
body.country_options.us.mass_transit_parking_tax | object | Optional | |
body.country_options.us.mass_transit_parking_tax.jurisdiction | string | Required within parent | Maximum length: 5000 |
body.country_options.us.parking_tax | object | Optional | |
body.country_options.us.parking_tax.jurisdiction | string | Required within parent | Maximum length: 5000 |
body.country_options.us.resort_tax | object | Optional | |
body.country_options.us.resort_tax.jurisdiction | string | Required within parent | Maximum length: 5000 |
body.country_options.us.state | string | Required within parent | Maximum length: 5000 |
body.country_options.us.state_sales_tax | object | Optional | |
body.country_options.us.state_sales_tax.elections | array | Required within parent | |
body.country_options.us.state_sales_tax.elections[] | object | Each item | |
body.country_options.us.state_sales_tax.elections[].jurisdiction | string | Optional | Maximum length: 5000 |
body.country_options.us.state_sales_tax.elections[].type | string | Required within parent | One of: local_use_tax, simplified_sellers_use_tax, single_local_use_tax |
body.country_options.us.tourism_tax | object | Optional | |
body.country_options.us.tourism_tax.jurisdiction | string | Required within parent | Maximum length: 5000 |
body.country_options.us.type | string | Required within parent | One of: admissions_tax, attendance_tax, entertainment_tax, gross_receipts_tax, hospitality_tax, local_amusement_tax, local_lease_tax, luxury_tax, mass_transit_parking_tax, parking_tax, resort_tax, state_communications_tax, state_retail_delivery_fee, state_sales_tax, tourism_tax |
body.country_options.uy | object | Optional | |
body.country_options.uy.standard | object | Optional | |
body.country_options.uy.standard.place_of_supply_scheme | string | Optional | One of: inbound_goods, standard |
body.country_options.uy.type | string | Required within parent | One of: standard |
body.country_options.uz | object | Optional | |
body.country_options.uz.type | string | Required within parent | One of: simplified |
body.country_options.vn | object | Optional | |
body.country_options.vn.type | string | Required within parent | One of: simplified |
body.country_options.za | object | Optional | |
body.country_options.za.standard | object | Optional | |
body.country_options.za.standard.place_of_supply_scheme | string | Optional | One of: inbound_goods, standard |
body.country_options.za.type | string | Required within parent | One of: standard |
body.country_options.zm | object | Optional | |
body.country_options.zm.type | string | Required within parent | One of: simplified |
body.country_options.zw | object | Optional | |
body.country_options.zw.standard | object | Optional | |
body.country_options.zw.standard.place_of_supply_scheme | string | Optional | One of: inbound_goods, standard |
body.country_options.zw.type | string | Required within parent | One of: standard |
body.expand | array | Optional | Specifies which fields in the response should be expanded. |
body.expand[] | string | Each item | Maximum length: 5000 |
body.expires_at | integer | Optional | 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. Format: unix-time |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Create a registration — response body |
Referenced models: Create a registration — response body
Schemas
Section titled “Schemas”8 more schemas are linked from the tables above, on the schema pages.
Create a registration — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A Tax `Registration` lets us know that your business is registered to collect tax on payments within a region, enabling you to [automatically collect tax](https://docs.stripe.com/tax). Stripe doesn't register on your behalf with the relevant authorities when you create a Tax `Registration` object. For more information on how to register to collect tax, see [our guide](https://docs.stripe.com/tax/registering). Related guide: [Using the Registrations API](https://docs.stripe.com/tax/registrations-api) |
active_from | JSON | Required within parent | |
active_from (anyOf 1) | integer | Alternative | Time at which the registration becomes active. Measured in seconds since the Unix epoch. Format: unix-time |
active_from (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
country | string | Required within parent | Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). Maximum length: 5000 |
country_options | Model | Required within parent | Expand Create a registration — response body — country options |
created | JSON | Required within parent | |
created (anyOf 1) | integer | Alternative | Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time |
created (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
expires_at | JSON | Optional | |
expires_at (anyOf 1) | JSON | Alternative | |
expires_at (anyOf 1) (anyOf 1) | integer | Alternative | If set, the registration stops being active at this time. If not set, the registration will be active indefinitely. Measured in seconds since the Unix epoch. Format: unix-time |
expires_at (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
expires_at (anyOf 2) | null | Alternative | |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
livemode | boolean | Required within parent | If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: tax.registration |
status | string | Required within parent | The status of the registration. This field is present for convenience and can be deduced from `active_from` and `expires_at`. Known values: active, expired, scheduled |
Referenced models: Create a registration — response body — country options
Create a registration — response body — country options ca
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
province_standard | Model | Optional | Expand Create a registration — response body — country options ca province standard |
type | string | Required within parent | Type of registration in Canada. Known values: province_standard, simplified, standard |
Referenced models: Create a registration — response body — country options ca province standard
Create a registration — response body — country options al
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
type | string | Required within parent | Type of registration in `country`. Known values: standard |
Create a registration — response body — country options ae
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
standard | Model | Optional | Expand Create a registration — response body — country options ae standard |
type | string | Required within parent | Type of registration in `country`. Known values: standard |
Referenced models: Create a registration — response body — country options ae standard
Create a registration — response body — country options at
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
standard | Model | Optional | Expand Create a registration — response body — country options at standard |
type | string | Required within parent | Type of registration in an EU country. Known values: ioss, oss_non_union, oss_union, standard |
Referenced models: Create a registration — response body — country options at standard
Create a registration — response body — country options am
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
type | string | Required within parent | Type of registration in `country`. Known values: simplified |
Create a registration — response body — country options es
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
standard | Model | Optional | Expand Create a registration — response body — country options at standard |
type | string | Required within parent | Type of registration in ES. Known values: ioss, oss_non_union, oss_union, standard |
Referenced models: Create a registration — response body — country options at standard
Create a registration — response body — country options ca province standard
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
province | string | Required within parent | Two-letter CA province code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). Maximum length: 5000 |
Create a registration — response body — country options ae standard
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
place_of_supply_scheme | string | Required within parent | Place of supply scheme used in an Default standard registration. Known values: inbound_goods, standard |
Create a registration — response body — country options at standard
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
place_of_supply_scheme | string | Required within parent | Place of supply scheme used in an EU standard registration. Known values: inbound_goods, small_seller, standard |
Create a registration — response body — country options us admissions tax
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
jurisdiction | string | Required within parent | A [jurisdiction code](https://docs.stripe.com/tax/registering?type=admissions_tax#registration-types) representing the local jurisdiction. Maximum length: 5000 |
Create a registration — response body — country options us attendance tax
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
jurisdiction | string | Required within parent | A [jurisdiction code](https://docs.stripe.com/tax/registering?type=attendance_tax#registration-types) representing the local jurisdiction. Maximum length: 5000 |
Create a registration — response body — country options us entertainment tax
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
jurisdiction | string | Required within parent | A [jurisdiction code](https://docs.stripe.com/tax/registering?type=entertainment_tax#registration-types) representing the local jurisdiction. Maximum length: 5000 |
Create a registration — response body — country options us gross receipts tax
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
jurisdiction | string | Required within parent | A [jurisdiction code](https://docs.stripe.com/tax/registering?type=gross_receipts_tax#registration-types) representing the local jurisdiction. Maximum length: 5000 |
Create a registration — response body — country options us hospitality tax
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
jurisdiction | string | Required within parent | A [jurisdiction code](https://docs.stripe.com/tax/registering?type=hospitality_tax#registration-types) representing the local jurisdiction. Maximum length: 5000 |
Create a registration — response body — country options us local lease tax
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
jurisdiction | string | Required within parent | A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. Maximum length: 5000 |
Create a registration — response body — country options us luxury tax
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
jurisdiction | string | Required within parent | A [jurisdiction code](https://docs.stripe.com/tax/registering?type=luxury_tax#registration-types) representing the local jurisdiction. Maximum length: 5000 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: stripe.posttaxregistrations. Catalog operation: PostTaxRegistrations. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Pinned headers: {"Stripe-Version": "2026-09-30.endive"}