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

# Transfer Plan

> Moves one of a customer's plans between entities, or between an entity and the customer. Nothing is charged or refunded.

Moves one of a customer's plans between entities, from an entity to the customer, or from the customer to an entity. Nothing is charged or refunded, and the Stripe subscription doesn't change.

Set at least one of `from_entity_id` or `to_entity_id`. Leaving one out means the customer level.

> [!NOTE]
>
> If the plan has a quantity above 1, one unit moves and the rest stay where they are. The destination isn't checked for an existing plan in the same group.

> [!WARNING]
>
> Plans with license pools can't be transferred.

### Body Parameters

The ID of the customer whose plan to transfer.

The entity to move the plan from. Omit to move a customer-level plan.

The entity to move the plan to. Omit to move the plan to the customer level.

The ID of the plan to transfer.

The ID of the customer's plan instance, when several instances of plan\_id match.

### Response


## OpenAPI

````yaml openapi POST /v1/billing.transfer
openapi: 3.1.0
info:
  title: Autumn API
  version: 2.6.0
servers:
  - url: https://api.useautumn.com
    description: Production server
security:
  - secretKey: []
paths:
  /v1/billing.transfer:
    post:
      tags:
        - billing
      description: >-
        Moves one of a customer's plans between entities, or between an entity
        and the customer. Nothing is charged or refunded.
      operationId: billingTransfer
      parameters:
        - name: x-api-version
          in: header
          required: true
          schema:
            type: string
            default: 2.6.0
          x-speakeasy-globals-hidden: true
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                customer_id:
                  type: string
                  description: The ID of the customer whose plan to transfer.
                from_entity_id:
                  anyOf:
                    - type: string
                    - type: 'null'
                  description: >-
                    The entity to move the plan from. Omit to move a
                    customer-level plan.
                to_entity_id:
                  anyOf:
                    - type: string
                    - type: 'null'
                  description: >-
                    The entity to move the plan to. Omit to move the plan to the
                    customer level.
                plan_id:
                  type: string
                  description: The ID of the plan to transfer.
                customer_plan_id:
                  anyOf:
                    - type: string
                    - type: 'null'
                  description: >-
                    The ID of the customer's plan instance, when several
                    instances of plan_id match.
              required:
                - customer_id
                - plan_id
              title: BillingTransferParams
              examples:
                - customer_id: cus_123
                  from_entity_id: seat_1
                  to_entity_id: seat_2
                  plan_id: pro
            example:
              customer_id: cus_123
              from_entity_id: seat_1
              to_entity_id: seat_2
              plan_id: pro
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                required:
                  - success
      x-codeSamples:
        - lang: typescript
          label: Typescript (SDK)
          source: |-
            import { Autumn } from 'autumn-js'

            const autumn = new Autumn()

            const result = await autumn.billing.transfer({
              customerId: "cus_123",
              fromEntityId: "seat_1",
              toEntityId: "seat_2",
              planId: "pro",
            });
        - lang: python
          label: Python (SDK)
          source: |-
            from autumn_sdk import Autumn

            autumn = Autumn(secret_key="am_sk_test...")

            res = autumn.billing.transfer(
                customer_id="cus_123",
                plan_id="pro",
                from_entity_id="seat_1",
                to_entity_id="seat_2",
            )
components:
  securitySchemes:
    secretKey:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.