> ## Documentation Index
> Fetch the complete documentation index at: https://docs.useplinth.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# Provision a virtual account

> Creates a dedicated bank account number (virtual account) for the customer. Transfers sent to this account are automatically matched to open invoices. One virtual account per customer.




## OpenAPI

````yaml POST /v1/customers/{id}/virtual-account
openapi: 3.0.3
info:
  title: Plinth API
  version: 0.9.0
  description: >
    Recurring billing for Nigerian SaaS — card charging, bank transfers via
    virtual accounts,

    proration, dunning, and recovery in one API.


    All amounts are in **kobo** (1/100th of a Naira). ₦5,000 = `500000`.
servers:
  - url: https://api.useplinth.com
    description: Production
  - url: http://localhost:7331
    description: Local development
security:
  - BearerAuth: []
tags:
  - name: Sandbox
    description: Create an isolated sandbox environment for testing. No auth required.
  - name: Customers
    description: Who you are billing. One customer can have multiple subscriptions.
  - name: Plans
    description: Plan groups and the plans within them. Customers subscribe to plans.
  - name: Subscriptions
    description: The recurring billing relationship between a customer and a plan.
  - name: Virtual Accounts
    description: Dedicated bank account numbers for customers who pay by transfer.
  - name: Invoices
    description: Created at each billing cycle. Tracks what a customer owes for a period.
  - name: Webhooks
    description: >-
      Register endpoints that receive signed, retried events. See Receiving
      webhooks.
  - name: Admin
    description: Test clock control, billing tick, and suspense resolution. Test-mode only.
paths:
  /v1/customers/{id}/virtual-account:
    post:
      tags:
        - Virtual Accounts
      summary: Provision a virtual account
      description: >
        Creates a dedicated bank account number (virtual account) for the
        customer. Transfers sent to this account are automatically matched to
        open invoices. One virtual account per customer.
      operationId: provision-virtual-account
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          example: cus_01JABC...
      responses:
        '201':
          description: Virtual account provisioned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VirtualAccount'
              example:
                object: virtual_account
                id: va_01JABC...
                customer_id: cus_01JABC...
                account_number: '9391234567'
                bank_name: Nomba MFB
                account_name: Acme Corp — Plinth
                account_ref: cus_01JABC...
                created_at: '2026-06-01T00:00:00Z'
        '409':
          description: Customer already has a virtual account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    VirtualAccount:
      type: object
      properties:
        object:
          type: string
          enum:
            - virtual_account
        id:
          type: string
          example: va_01JABC...
        customer_id:
          type: string
          example: cus_01JABC...
        account_number:
          type: string
          example: '9391234567'
        bank_name:
          type: string
          example: Nomba MFB
        account_name:
          type: string
          example: Acme Corp — Plinth
        account_ref:
          type: string
          example: cus_01JABC...
        created_at:
          type: string
          format: date-time
    Error:
      type: object
      properties:
        error:
          type: string
          example: Not found
        code:
          type: string
          example: not_found
      required:
        - error
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >
        Use `sk_test_` keys for sandbox. Use `sk_live_` keys for production.
        Obtain your key from the dashboard.

````