Create a Stripe, Creem or app-sync connection

POST /admin/v1/workspaces/{workspaceId}/billing-connections — Create a Stripe, Creem or app-sync connection

Endpoint

POST /admin/v1/workspaces/{workspaceId}/billing-connections

Operation ID: createBillingConnection

Authentication

Send a Nexus Management Key as Authorization: Bearer <management-key>. This credential is control-plane only.

Idempotency

This operation does not declare an Idempotency-Key requirement in the accepted OpenAPI contract.

Request

Parameters

Name	Location	Required	Schema	Description
`workspaceId`	path	Yes	`string`	—

application/json body

Required: Yes

Type: CreateBillingConnectionDto

Field	Required	Type	Description
`provider`	Yes	`string (STRIPE \| CREEM)`	—
`mode`	Yes	`string`	—
`name`	No	`string`	—

Responses

Status	Description	Content type	Schema
`201`	—	application/json	`BillingConnectionDto`

Only responses explicitly declared by the accepted Admin OpenAPI contract are shown. The current contract does not declare operation-specific error bodies; the SDK preserves any non-success status and body in AdminApiError.

`201` application/json schema

Type: BillingConnectionDto

Field	Required	Type	Description
`id`	Yes	`string`	—
`workspaceId`	Yes	`string`	—
`kind`	Yes	`string (HOSTED \| APP_SYNC)`	—
`provider`	Yes	`string (STRIPE \| CREEM)`	—
`mode`	Yes	`string`	—
`status`	Yes	`string`	—
`name`	Yes	`string`	—
`webhookUrl`	Yes	`string / uri`	—
`credentialConfigured`	Yes	`boolean`	—
`webhookSecretConfigured`	Yes	`boolean`	—
`credentialVerificationStatus`	Yes	`string`	—
`credentialPreview`	No	`string`	—
`lastVerifiedAt`	No	`string / date-time`	—
`externalAccountId`	No	`string`	—

Examples

TypeScript Management SDK

NexusAdminClient.createBillingConnection uses AdminOperationInput<"createBillingConnection"> and returns Promise<AdminOperationOutput<"createBillingConnection">>.

import { NexusAdminClient } from '@nexus/sdk-typescript';

const nexus = new NexusAdminClient({
  baseUrl: 'https://nexus.microvoid.io',
  managementKey: process.env.NEXUS_MANAGEMENT_KEY,
});

const result = await nexus.createBillingConnection({
  path: {
    workspaceId: '533c4e1e-2823-4349-86b9-d6f1a869a2ca',
  },
  body: {
    provider: 'STRIPE',
    mode: 'string',
  },
});

Fetch

const response = await fetch(
  'https://nexus.microvoid.io/admin/v1/workspaces/533c4e1e-2823-4349-86b9-d6f1a869a2ca/billing-connections',
  {
    method: 'POST',
    headers: {
      Authorization: `Bearer ${process.env.NEXUS_MANAGEMENT_KEY}`,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      provider: 'STRIPE',
      mode: 'string',
    }),
  },
);

if (!response.ok) throw new Error(`Nexus request failed: ${response.status}`);

curl

curl --request POST \
  "https://nexus.microvoid.io/admin/v1/workspaces/533c4e1e-2823-4349-86b9-d6f1a869a2ca/billing-connections" \
  --header "Authorization: Bearer ${NEXUS_MANAGEMENT_KEY}" \
  --header "Content-Type: application/json" \
  --data "{\"provider\":\"STRIPE\",\"mode\":\"string\"}"