Skip to content

The open alternative to Salesforce, designed for AI.

Add a billingPlans query and deprecate listPlans (#29003)

Félix Malfaitf44e7d3961cf
diff --git a/packages/twenty-client-sdk/src/metadata/generated/schema.graphql b/packages/twenty-client-sdk/src/metadata/generated/schema.graphql
index 990436790fb..45490390553 100644
--- a/packages/twenty-client-sdk/src/metadata/generated/schema.graphql
+++ b/packages/twenty-client-sdk/src/metadata/generated/schema.graphql
@@ -3976,6 +3976,7 @@ type Query {
applicationRegistrationTarballUrl(id: String!): String
applicationSdkClientChecksums(applicationId: UUID!): SdkClientChecksums
barChartData(input: BarChartDataInput!): BarChartData!
+ billingPlans: [BillingPlan!]!
billingPortalSession(forPaymentMethodUpdate: Boolean, returnUrlPath: String): BillingSession!
callRecordingIdForCalendarEvent(calendarEventId: UUID!): UUID
chatMessages(threadId: UUID!): [AgentMessage!]!
@@ -4076,7 +4077,7 @@ type Query {
githubClaimAuthorizationUrl(applicationRegistrationId: String!): String!
isApplicationStopped(applicationUniversalIdentifier: String!): Boolean!
lineChartData(input: LineChartDataInput!): LineChartData!
- listPlans: [BillingPlan!]!
+ listPlans: [BillingPlan!]! @deprecated(reason: "Use billingPlans instead.")
messageSuppressions(input: FindMessageSuppressionsInput!): MessageSuppressionList!
metadataTranslations(input: MetadataTranslationsInput!): [MetadataTranslation!]!
minimalMetadata: MinimalMetadata!
diff --git a/packages/twenty-client-sdk/src/metadata/generated/schema.ts b/packages/twenty-client-sdk/src/metadata/generated/schema.ts
index ca245cc1402..d8f28fdbd86 100644
--- a/packages/twenty-client-sdk/src/metadata/generated/schema.ts
+++ b/packages/twenty-client-sdk/src/metadata/generated/schema.ts
@@ -2931,6 +2931,7 @@ export interface Query {
applicationRegistrationTarballUrl?: Scalars['String']
applicationSdkClientChecksums?: SdkClientChecksums
barChartData: BarChartData
+ billingPlans: BillingPlan[]
billingPortalSession: BillingSession
callRecordingIdForCalendarEvent?: Scalars['UUID']
chatMessages: AgentMessage[]
@@ -3022,6 +3023,7 @@ export interface Query {
githubClaimAuthorizationUrl: Scalars['String']
isApplicationStopped: Scalars['Boolean']
lineChartData: LineChartData
+ /** @deprecated Use billingPlans instead. */
listPlans: BillingPlan[]
messageSuppressions: MessageSuppressionList
metadataTranslations: MetadataTranslation[]
@@ -7410,6 +7412,7 @@ export interface QueryGenqlSelection{
applicationRegistrationTarballUrl?: { __args: {id: Scalars['String']} }
applicationSdkClientChecksums?: (SdkClientChecksumsGenqlSelection & { __args: {applicationId: Scalars['UUID']} })
barChartData?: (BarChartDataGenqlSelection & { __args: {input: BarChartDataInput} })
+ billingPlans?: BillingPlanGenqlSelection
billingPortalSession?: (BillingSessionGenqlSelection & { __args?: {forPaymentMethodUpdate?: (Scalars['Boolean'] | null), returnUrlPath?: (Scalars['String'] | null)} })
callRecordingIdForCalendarEvent?: { __args: {calendarEventId: Scalars['UUID']} }
chatMessages?: (AgentMessageGenqlSelection & { __args: {threadId: Scalars['UUID']} })
@@ -7507,6 +7510,7 @@ export interface QueryGenqlSelection{
githubClaimAuthorizationUrl?: { __args: {applicationRegistrationId: Scalars['String']} }
isApplicationStopped?: { __args: {applicationUniversalIdentifier: Scalars['String']} }
lineChartData?: (LineChartDataGenqlSelection & { __args: {input: LineChartDataInput} })
+ /** @deprecated Use billingPlans instead. */
listPlans?: BillingPlanGenqlSelection
messageSuppressions?: (MessageSuppressionListGenqlSelection & { __args: {input: FindMessageSuppressionsInput} })
metadataTranslations?: (MetadataTranslationGenqlSelection & { __args: {input: MetadataTranslationsInput} })
diff --git a/packages/twenty-client-sdk/src/metadata/generated/types.ts b/packages/twenty-client-sdk/src/metadata/generated/types.ts
index 46e5a7a2d72..ddeabb7d8ca 100644
--- a/packages/twenty-client-sdk/src/metadata/generated/types.ts
+++ b/packages/twenty-client-sdk/src/metadata/generated/types.ts
@@ -10431,6 +10431,9 @@ export default {
]
}
],
+ "billingPlans": [
+ 105
+ ],
"billingPortalSession": [
115,
{
diff --git a/packages/twenty-front/src/generated-metadata/graphql.ts b/packages/twenty-front/src/generated-metadata/graphql.ts
index cd9857f5562..726d609a3c3 100644
--- a/packages/twenty-front/src/generated-metadata/graphql.ts
+++ b/packages/twenty-front/src/generated-metadata/graphql.ts
@@ -5645,6 +5645,7 @@ export type Query = {
applicationRegistrationTarballUrl?: Maybe<Scalars['String']['output']>;
applicationSdkClientChecksums?: Maybe<SdkClientChecksums>;
barChartData: BarChartData;
+ billingPlans: Array<BillingPlan>;
billingPortalSession: BillingSession;
callRecordingIdForCalendarEvent?: Maybe<Scalars['UUID']['output']>;
chatMessages: Array<AgentMessage>;
@@ -5736,6 +5737,7 @@ export type Query = {
githubClaimAuthorizationUrl: Scalars['String']['output'];
isApplicationStopped: Scalars['Boolean']['output'];
lineChartData: LineChartData;
+ /** @deprecated Use billingPlans instead. */
listPlans: Array<BillingPlan>;
messageSuppressions: MessageSuppressionList;
metadataTranslations: Array<MetadataTranslation>;
diff --git a/packages/twenty-server/src/engine/core-modules/billing/billing.resolver.ts b/packages/twenty-server/src/engine/core-modules/billing/billing.resolver.ts
index bd5202776a9..59f35d2b13c 100644
--- a/packages/twenty-server/src/engine/core-modules/billing/billing.resolver.ts
+++ b/packages/twenty-server/src/engine/core-modules/billing/billing.resolver.ts
@@ -462,12 +462,33 @@ export class BillingResolver {
}),
NoPermissionGuard,
)
- async listPlans(): Promise<BillingPlanDTO[]> {
+ async billingPlans(): Promise<BillingPlanDTO[]> {
const plans = await this.billingPlanService.listPlans();
return plans.map(formatBillingDatabaseProductToGraphqlDTO);
}
+ @Query(() => [BillingPlanDTO], {
+ deprecationReason: 'Use billingPlans instead.',
+ })
+ @UseGuards(
+ AuthPrincipalGuard({
+ userSession: {
+ standard: true,
+ impersonated: true,
+ playground: true,
+ workspaceAgnostic: false,
+ },
+ apiKey: true,
+ oauthClient: true,
+ application: true,
+ }),
+ NoPermissionGuard,
+ )
+ async listPlans(): Promise<BillingPlanDTO[]> {
+ return this.billingPlans();
+ }
+
@Mutation(() => BillingEndTrialPeriodDTO)
@UseGuards(
AuthPrincipalGuard({
diff --git a/packages/twenty-server/test/integration/billing/suites/billing-plans-query.integration-spec.ts b/packages/twenty-server/test/integration/billing/suites/billing-plans-query.integration-spec.ts
new file mode 100644
index 00000000000..a1a0b2e8b1c
--- /dev/null
+++ b/packages/twenty-server/test/integration/billing/suites/billing-plans-query.integration-spec.ts
@@ -0,0 +1,26 @@
+import gql from 'graphql-tag';
+import { makeMetadataApiRequest } from 'test/integration/metadata/suites/utils/make-metadata-api-request.util';
+
+describe('billingPlans query', () => {
+ it('returns the same plans as the deprecated listPlans', async () => {
+ const response = await makeMetadataApiRequest({
+ query: gql`
+ query BillingPlansAndDeprecatedListPlans {
+ billingPlans {
+ planKey
+ isSellable
+ }
+ listPlans {
+ planKey
+ isSellable
+ }
+ }
+ `,
+ });
+
+ expect(response.body.errors).toBeUndefined();
+ expect(response.body.data.billingPlans).toEqual(
+ response.body.data.listPlans,
+ );
+ });
+});
diff --git a/packages/twenty-server/test/integration/endpoint-permissions/__snapshots__/endpoint-permission-declarations.integration-spec.ts.snap b/packages/twenty-server/test/integration/endpoint-permissions/__snapshots__/endpoint-permission-declarations.integration-spec.ts.snap
index 392dddbc475..3b847925f3a 100644
--- a/packages/twenty-server/test/integration/endpoint-permissions/__snapshots__/endpoint-permission-declarations.integration-spec.ts.snap
+++ b/packages/twenty-server/test/integration/endpoint-permissions/__snapshots__/endpoint-permission-declarations.integration-spec.ts.snap
@@ -219,6 +219,7 @@ exports[`endpoint permission declarations should match the auth principals, perm
"AuthResolver.verifyEmailAndGetLoginToken {"applicationTarget":null,"authPrincipalGuards":[],"requiredFeatureFlags":[],"requiredPermissionFlags":[]}",
"AuthResolver.verifyEmailAndGetWorkspaceAgnosticToken {"applicationTarget":null,"authPrincipalGuards":[],"requiredFeatureFlags":[],"requiredPermissionFlags":[]}",
"BarChartDataResolver.barChartData {"applicationTarget":null,"authPrincipalGuards":[{"apiKey":true,"application":{"withAgent":false,"withUser":true,"withoutUser":true},"oauthClient":{"withUser":true,"withoutUser":true},"userSession":{"impersonated":true,"playground":true,"standard":true,"workspaceAgnostic":false}}],"requiredFeatureFlags":[],"requiredPermissionFlags":[]}",
+ "BillingResolver.billingPlans {"applicationTarget":null,"authPrincipalGuards":[{"apiKey":true,"application":{"withAgent":false,"withUser":true,"withoutUser":true},"oauthClient":{"withUser":true,"withoutUser":true},"userSession":{"impersonated":true,"playground":true,"standard":true,"workspaceAgnostic":false}}],"requiredFeatureFlags":[],"requiredPermissionFlags":[]}",
"BillingResolver.billingPortalSession {"applicationTarget":null,"authPrincipalGuards":[{"apiKey":true,"application":{"withAgent":false,"withUser":false,"withoutUser":false},"oauthClient":{"withUser":true,"withoutUser":true},"userSession":{"impersonated":true,"playground":true,"standard":true,"workspaceAgnostic":false}}],"requiredFeatureFlags":[],"requiredPermissionFlags":["BILLING"]}",
"BillingResolver.cancelSwitchBillingInterval {"applicationTarget":null,"authPrincipalGuards":[{"apiKey":true,"application":{"withAgent":false,"withUser":false,"withoutUser":false},"oauthClient":{"withUser":true,"withoutUser":true},"userSession":{"impersonated":true,"playground":true,"standard":true,"workspaceAgnostic":false}}],"requiredFeatureFlags":[],"requiredPermissionFlags":["BILLING"]}",
"BillingResolver.cancelSwitchBillingPlan {"applicationTarget":null,"authPrincipalGuards":[{"apiKey":true,"application":{"withAgent":false,"withUser":false,"withoutUser":false},"oauthClient":{"withUser":true,"withoutUser":true},"userSession":{"impersonated":true,"playground":true,"standard":true,"workspaceAgnostic":false}}],"requiredFeatureFlags":[],"requiredPermissionFlags":["BILLING"]}",