Skip to content

Billing

Generated TypeScript Management SDK methods for Billing.

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

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
configureBillingWebhookSecret PUT /admin/v1/billing-connections/{connectionId}/webhook-secret API
createBillingConnection POST /admin/v1/workspaces/{workspaceId}/billing-connections API
createBillingProductMapping POST /admin/v1/billing-connections/{connectionId}/product-mappings API
createCheckout POST /admin/v1/workspace-accesses/{accessId}/billing-checkouts API
deleteBillingProductMapping DELETE /admin/v1/billing-product-mappings/{mappingId} API
disableBillingConnection DELETE /admin/v1/billing-connections/{connectionId} API
listBillingConnections GET /admin/v1/workspaces/{workspaceId}/billing-connections API
listBillingProductMappings GET /admin/v1/billing-connections/{connectionId}/product-mappings API
listBillingWebhookEvents GET /admin/v1/billing-connections/{connectionId}/webhook-events API
listExternalSubscriptions GET /admin/v1/workspace-accesses/{accessId}/external-subscriptions API
reconcileBillingConnection POST /admin/v1/billing-connections/{connectionId}/reconcile API
replayBillingWebhookEvent POST /admin/v1/webhook-events/{eventId}/replay API
syncWorkspaceAccessBillingPeriod POST /admin/v1/workspace-accesses/{accessId}/billing-periods/sync API
verifyBillingConnection POST /admin/v1/billing-connections/{connectionId}/verify API

Method signatures

configureBillingProviderCredential

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

Store or rotate a billing provider credential

configureBillingWebhookSecret

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

Store or rotate a billing webhook signing secret

createBillingConnection

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

Create a Stripe, Creem or app-sync connection

createBillingProductMapping

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

Map an external Product/Price to a workspace plan

createCheckout

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

Create a provider-neutral hosted subscription Checkout

deleteBillingProductMapping

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

Disable a product mapping

disableBillingConnection

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

Disable a billing connection

listBillingConnections

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

List billing connections

listBillingProductMappings

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

List product mappings

listBillingWebhookEvents

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

List webhook inbox events

listExternalSubscriptions

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

List external subscription projections

reconcileBillingConnection

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

Start external subscription reconciliation

replayBillingWebhookEvent

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

Replay a failed webhook inbox event

syncWorkspaceAccessBillingPeriod

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

Idempotently synchronize an external billing period

verifyBillingConnection

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

Verify billing provider credentials

Navigation

Type to search…

↑↓ navigate↵ selectEsc close