Skip to content

Disable a billing connection

DELETE /admin/v1/billing-connections/{connectionId} — Disable a billing connection

Updated View as Markdown
Audience: application-backendPlane: adminAuth: management-keyStatus: beta

Endpoint

DELETE /admin/v1/billing-connections/{connectionId}

Operation ID: disableBillingConnection

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
connectionId path Yes string

Body

This operation has no request body.

Responses

Status Description Content type Schema
204

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.

Examples

TypeScript Management SDK

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

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.disableBillingConnection({
  path: {
    connectionId: '533c4e1e-2823-4349-86b9-d6f1a869a2ca',
  },
});

Fetch

const response = await fetch(
  'https://nexus.microvoid.io/admin/v1/billing-connections/533c4e1e-2823-4349-86b9-d6f1a869a2ca',
  {
    method: 'DELETE',
    headers: {
      Authorization: `Bearer ${process.env.NEXUS_MANAGEMENT_KEY}`,
    },
  },
);

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

curl

curl --request DELETE \
  "https://nexus.microvoid.io/admin/v1/billing-connections/533c4e1e-2823-4349-86b9-d6f1a869a2ca" \
  --header "Authorization: Bearer ${NEXUS_MANAGEMENT_KEY}"
Navigation

Type to search…

↑↓ navigate↵ selectEsc close