---
title: "Billing"
description: "Generated TypeScript Management SDK methods for Billing."
---

> Documentation Index
> Fetch the complete documentation index at: https://nexus.microvoid.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Billing

These methods are generated from the Admin OpenAPI contract. They configure the control plane; they do not send model requests.

| Method                               | HTTP     | Path                                                               | Reference                                                                 |
| ------------------------------------ | -------- | ------------------------------------------------------------------ | ------------------------------------------------------------------------- |
| `configureBillingProviderCredential` | `PUT`    | `/admin/v1/billing-connections/{connectionId}/provider-credential` | [API](/api-reference/admin/billing/configure-billing-provider-credential) |
| `configureBillingWebhookSecret`      | `PUT`    | `/admin/v1/billing-connections/{connectionId}/webhook-secret`      | [API](/api-reference/admin/billing/configure-billing-webhook-secret)      |
| `createBillingConnection`            | `POST`   | `/admin/v1/workspaces/{workspaceId}/billing-connections`           | [API](/api-reference/admin/billing/create-billing-connection)             |
| `createBillingProductMapping`        | `POST`   | `/admin/v1/billing-connections/{connectionId}/product-mappings`    | [API](/api-reference/admin/billing/create-billing-product-mapping)        |
| `createCheckout`                     | `POST`   | `/admin/v1/workspace-accesses/{accessId}/billing-checkouts`        | [API](/api-reference/admin/billing/create-checkout)                       |
| `deleteBillingProductMapping`        | `DELETE` | `/admin/v1/billing-product-mappings/{mappingId}`                   | [API](/api-reference/admin/billing/delete-billing-product-mapping)        |
| `disableBillingConnection`           | `DELETE` | `/admin/v1/billing-connections/{connectionId}`                     | [API](/api-reference/admin/billing/disable-billing-connection)            |
| `listBillingConnections`             | `GET`    | `/admin/v1/workspaces/{workspaceId}/billing-connections`           | [API](/api-reference/admin/billing/list-billing-connections)              |
| `listBillingProductMappings`         | `GET`    | `/admin/v1/billing-connections/{connectionId}/product-mappings`    | [API](/api-reference/admin/billing/list-billing-product-mappings)         |
| `listBillingWebhookEvents`           | `GET`    | `/admin/v1/billing-connections/{connectionId}/webhook-events`      | [API](/api-reference/admin/billing/list-billing-webhook-events)           |
| `listExternalSubscriptions`          | `GET`    | `/admin/v1/workspace-accesses/{accessId}/external-subscriptions`   | [API](/api-reference/admin/billing/list-external-subscriptions)           |
| `reconcileBillingConnection`         | `POST`   | `/admin/v1/billing-connections/{connectionId}/reconcile`           | [API](/api-reference/admin/billing/reconcile-billing-connection)          |
| `replayBillingWebhookEvent`          | `POST`   | `/admin/v1/webhook-events/{eventId}/replay`                        | [API](/api-reference/admin/billing/replay-billing-webhook-event)          |
| `syncWorkspaceAccessBillingPeriod`   | `POST`   | `/admin/v1/workspace-accesses/{accessId}/billing-periods/sync`     | [API](/api-reference/admin/billing/sync-workspace-access-billing-period)  |
| `verifyBillingConnection`            | `POST`   | `/admin/v1/billing-connections/{connectionId}/verify`              | [API](/api-reference/admin/billing/verify-billing-connection)             |

## Method signatures

### `configureBillingProviderCredential`

```ts
nexus.configureBillingProviderCredential(
  input: AdminOperationInput<"configureBillingProviderCredential">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"configureBillingProviderCredential">>
```

Store or rotate a billing provider credential

### `configureBillingWebhookSecret`

```ts
nexus.configureBillingWebhookSecret(
  input: AdminOperationInput<"configureBillingWebhookSecret">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"configureBillingWebhookSecret">>
```

Store or rotate a billing webhook signing secret

### `createBillingConnection`

```ts
nexus.createBillingConnection(
  input: AdminOperationInput<"createBillingConnection">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"createBillingConnection">>
```

Create a Stripe, Creem or app-sync connection

### `createBillingProductMapping`

```ts
nexus.createBillingProductMapping(
  input: AdminOperationInput<"createBillingProductMapping">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"createBillingProductMapping">>
```

Map an external Product/Price to a workspace plan

### `createCheckout`

```ts
nexus.createCheckout(
  input: AdminOperationInput<"createCheckout">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"createCheckout">>
```

Create a provider-neutral hosted subscription Checkout

### `deleteBillingProductMapping`

```ts
nexus.deleteBillingProductMapping(
  input: AdminOperationInput<"deleteBillingProductMapping">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"deleteBillingProductMapping">>
```

Disable a product mapping

### `disableBillingConnection`

```ts
nexus.disableBillingConnection(
  input: AdminOperationInput<"disableBillingConnection">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"disableBillingConnection">>
```

Disable a billing connection

### `listBillingConnections`

```ts
nexus.listBillingConnections(
  input: AdminOperationInput<"listBillingConnections">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"listBillingConnections">>
```

List billing connections

### `listBillingProductMappings`

```ts
nexus.listBillingProductMappings(
  input: AdminOperationInput<"listBillingProductMappings">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"listBillingProductMappings">>
```

List product mappings

### `listBillingWebhookEvents`

```ts
nexus.listBillingWebhookEvents(
  input: AdminOperationInput<"listBillingWebhookEvents">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"listBillingWebhookEvents">>
```

List webhook inbox events

### `listExternalSubscriptions`

```ts
nexus.listExternalSubscriptions(
  input: AdminOperationInput<"listExternalSubscriptions">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"listExternalSubscriptions">>
```

List external subscription projections

### `reconcileBillingConnection`

```ts
nexus.reconcileBillingConnection(
  input: AdminOperationInput<"reconcileBillingConnection">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"reconcileBillingConnection">>
```

Start external subscription reconciliation

### `replayBillingWebhookEvent`

```ts
nexus.replayBillingWebhookEvent(
  input: AdminOperationInput<"replayBillingWebhookEvent">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"replayBillingWebhookEvent">>
```

Replay a failed webhook inbox event

### `syncWorkspaceAccessBillingPeriod`

```ts
nexus.syncWorkspaceAccessBillingPeriod(
  input: AdminOperationInput<"syncWorkspaceAccessBillingPeriod">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"syncWorkspaceAccessBillingPeriod">>
```

Idempotently synchronize an external billing period

### `verifyBillingConnection`

```ts
nexus.verifyBillingConnection(
  input: AdminOperationInput<"verifyBillingConnection">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"verifyBillingConnection">>
```

Verify billing provider credentials

Source: https://nexus.microvoid.io/management-sdk/reference/billing/index.mdx