Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

feat(billing): tax id dismissible banner (#43580)

Ignacio Dobronich2f9921bd811b
diff --git a/apps/studio/components/interfaces/App/AppBannerWrapper.tsx b/apps/studio/components/interfaces/App/AppBannerWrapper.tsx
index 215efbfa17d..392b0fbd1df 100644
--- a/apps/studio/components/interfaces/App/AppBannerWrapper.tsx
+++ b/apps/studio/components/interfaces/App/AppBannerWrapper.tsx
@@ -2,6 +2,7 @@ import { useFlag } from 'common'
import { ClockSkewBanner } from 'components/layouts/AppLayout/ClockSkewBanner'
import { NoticeBanner } from 'components/layouts/AppLayout/NoticeBanner'
import { StatusPageBanner } from 'components/layouts/AppLayout/StatusPageBanner'
+import { TaxIdBanner } from 'components/layouts/AppLayout/TaxIdBanner'
import { PropsWithChildren } from 'react'
import { OrganizationResourceBanner } from '../Organization/HeaderBanner'
@@ -16,6 +17,7 @@ export const AppBannerWrapper = ({ children }: PropsWithChildren<{}>) => {
<StatusPageBanner />
{showNoticeBanner && <NoticeBanner />}
<OrganizationResourceBanner />
+ <TaxIdBanner />
{clockSkewBanner && <ClockSkewBanner />}
</div>
{children}
diff --git a/apps/studio/components/interfaces/Organization/BillingSettings/BillingCustomerData/BillingCustomerData.tsx b/apps/studio/components/interfaces/Organization/BillingSettings/BillingCustomerData/BillingCustomerData.tsx
index 2c058bb94e6..b8e795618b2 100644
--- a/apps/studio/components/interfaces/Organization/BillingSettings/BillingCustomerData/BillingCustomerData.tsx
+++ b/apps/studio/components/interfaces/Organization/BillingSettings/BillingCustomerData/BillingCustomerData.tsx
@@ -1,4 +1,5 @@
import { PermissionAction } from '@supabase/shared-types/out/constants'
+import { useQueryClient } from '@tanstack/react-query'
import { useMemo, useState } from 'react'
import { toast } from 'sonner'
@@ -15,6 +16,7 @@ import { useOrganizationCustomerProfileQuery } from 'data/organizations/organiza
import { useOrganizationCustomerProfileUpdateMutation } from 'data/organizations/organization-customer-profile-update-mutation'
import { useOrganizationTaxIdQuery } from 'data/organizations/organization-tax-id-query'
import { useOrganizationTaxIdUpdateMutation } from 'data/organizations/organization-tax-id-update-mutation'
+import { organizationKeys } from 'data/organizations/keys'
import { useAsyncCheckPermissions } from 'hooks/misc/useCheckPermissions'
import { useSelectedOrganizationQuery } from 'hooks/misc/useSelectedOrganization'
import { Button, Card, CardFooter, Form_Shadcn_ as Form } from 'ui'
@@ -28,6 +30,7 @@ import { useBillingCustomerDataForm } from './useBillingCustomerDataForm'
export const BillingCustomerData = () => {
const { slug } = useParams()
+ const queryClient = useQueryClient()
const { data: selectedOrganization } = useSelectedOrganizationQuery()
const { can: canReadBillingCustomerData, isSuccess: isPermissionsLoaded } =
@@ -92,6 +95,19 @@ export const BillingCustomerData = () => {
toast.success('Successfully updated billing data')
+ // Optimistically update organization_missing_tax_id in the cached organizations list
+ // so the TaxIdBanner hides immediately. The server responds 304 Not Modified for a
+ // while after the tax ID is saved, so invalidation/refetch won't work here.
+ queryClient.setQueriesData<any[]>(
+ { queryKey: organizationKeys.list(), exact: true },
+ (prev) => {
+ if (!prev) return prev
+ return prev.map((org) =>
+ org.slug === slug ? { ...org, organization_missing_tax_id: data.tax_id == null } : org
+ )
+ }
+ )
+
setIsSubmitting(false)
} catch (error: any) {
toast.error(`Failed updating billing data: ${error.message}`)
diff --git a/apps/studio/components/layouts/AppLayout/TaxIdBanner.tsx b/apps/studio/components/layouts/AppLayout/TaxIdBanner.tsx
new file mode 100644
index 00000000000..c190f818400
--- /dev/null
+++ b/apps/studio/components/layouts/AppLayout/TaxIdBanner.tsx
@@ -0,0 +1,64 @@
+import { LOCAL_STORAGE_KEYS } from 'common'
+import { useRouter } from 'next/router'
+
+import { TAX_IDS } from '@/components/interfaces/Organization/BillingSettings/BillingCustomerData/TaxID.constants'
+import { HeaderBanner } from '@/components/interfaces/Organization/HeaderBanner'
+import { InlineLink } from '@/components/ui/InlineLink'
+import { useLocalStorageQuery } from '@/hooks/misc/useLocalStorage'
+import { useSelectedOrganizationQuery } from '@/hooks/misc/useSelectedOrganization'
+import { useOrganizationCustomerProfileQuery } from 'data/organizations/organization-customer-profile-query'
+
+const SUPPORTED_TAX_ID_COUNTRIES = new Set(TAX_IDS.map((t) => t.countryIso2))
+
+export const TaxIdBanner = () => {
+ const router = useRouter()
+ const { data: org } = useSelectedOrganizationQuery()
+ const slug = org?.slug
+
+ const [isDismissed, setIsDismissed, { isSuccess: isDismissLoaded }] = useLocalStorageQuery(
+ LOCAL_STORAGE_KEYS.TAX_ID_BANNER_DISMISSED(slug ?? ''),
+ false
+ )
+
+ const shouldFetch =
+ !!slug &&
+ org?.plan?.id !== 'free' &&
+ isDismissLoaded &&
+ !isDismissed &&
+ !!org?.organization_missing_tax_id
+
+ const { data: customerProfile } = useOrganizationCustomerProfileQuery(
+ { slug },
+ { enabled: shouldFetch, staleTime: 1000 * 60 * 30 }
+ )
+
+ const billingCountry = customerProfile?.address?.country
+ const hasSupportedTaxId = !!billingCountry && SUPPORTED_TAX_ID_COUNTRIES.has(billingCountry)
+
+ if (
+ router.pathname.includes('sign-in') ||
+ !org ||
+ org.plan?.id === 'free' ||
+ !isDismissLoaded ||
+ isDismissed ||
+ !org.organization_missing_tax_id ||
+ !hasSupportedTaxId
+ ) {
+ return null
+ }
+
+ return (
+ <HeaderBanner
+ variant="note"
+ title="Add a Tax ID to your organization"
+ description={
+ <>
+ If you are a registered business, please{' '}
+ <InlineLink href={`/org/${slug}/billing#address`}>add a Tax ID</InlineLink> to your
+ billing settings. Not applicable for individual users.
+ </>
+ }
+ onDismiss={() => setIsDismissed(true)}
+ />
+ )
+}
diff --git a/apps/studio/data/organizations/organization-tax-id-update-mutation.ts b/apps/studio/data/organizations/organization-tax-id-update-mutation.ts
index 19d1a1dc9d7..29d1d121c22 100644
--- a/apps/studio/data/organizations/organization-tax-id-update-mutation.ts
+++ b/apps/studio/data/organizations/organization-tax-id-update-mutation.ts
@@ -4,6 +4,7 @@ import { toast } from 'sonner'
import { del, handleError, put } from 'data/fetchers'
import type { ResponseError, UseCustomMutationOptions } from 'types'
import { organizationKeys } from './keys'
+import { invalidateOrganizationsQuery } from './organizations-query'
export type OrganizationTaxIdUpdateVariables = {
slug?: string
diff --git a/packages/common/constants/local-storage.ts b/packages/common/constants/local-storage.ts
index 361262d2f3c..d484857f70c 100644
--- a/packages/common/constants/local-storage.ts
+++ b/packages/common/constants/local-storage.ts
@@ -103,6 +103,10 @@ export const LOCAL_STORAGE_KEYS = {
// Observability banner dismissed
OBSERVABILITY_BANNER_DISMISSED: (ref: string) => `observability-banner-dismissed-${ref}`,
+
+ // Tax ID banner dismissed
+ TAX_ID_BANNER_DISMISSED: (slug: string) => `tax-id-banner-dismissed-${slug}`,
+
TABLE_EDITOR_NEW_FILTER_BANNER_DISMISSED: (ref: string) =>
`table-editor-new-filter-banner-dismissed-${ref}`,