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

# Update the billing plan

> Updates the organization's billing plan. Requires the `manage_billing` permission.

Update the org's billing plan (manage_billing)

**Not callable with an API key.** Requires `manage_billing`, which ConveYour never grants to service accounts (`deny_for_types: [service]`), so every API key gets `403`. Only a signed-in user with this permission can call it.

**Permission:** requires `manage_billing`.



## OpenAPI

````yaml /api-reference/specs/org.json put /api/org/plan
openapi: 3.1.0
info:
  title: ConveYour API — Org
  description: >-
    Read and update the current organization's settings, limits, plan, and
    billing.
  version: 1.0.0
servers:
  - url: https://{subdomain}.conveyour.com
    description: Your organization's ConveYour instance
    variables:
      subdomain:
        default: acme
        description: >-
          Your organization's slug — the subdomain you sign in on. Replace
          `acme` with yours: if you sign in at `bigco.conveyour.com`, enter
          `bigco`.
security:
  - conveyourToken: []
tags:
  - name: Org
    description: >-
      Read and update the current organization's settings, limits, plan, and
      billing.
paths:
  /api/org/plan:
    put:
      tags:
        - Org
      summary: Update the billing plan
      description: >-
        Updates the organization's billing plan. Requires the `manage_billing`
        permission.


        Update the org's billing plan (manage_billing)


        **Not callable with an API key.** Requires `manage_billing`, which
        ConveYour never grants to service accounts (`deny_for_types:
        [service]`), so every API key gets `403`. Only a signed-in user with
        this permission can call it.


        **Permission:** requires `manage_billing`.
      operationId: updateTheOrgSBillingPlanManageBilling
      parameters:
        - $ref: '#/components/parameters/teams'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - plan
              properties:
                plan:
                  description: The plan ID to switch to.
                  type: string
                trial_end:
                  description: Set to `now` to end the trial immediately.
                  type: string
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Envelope'
                  - type: object
                    properties:
                      data:
                        oneOf:
                          - $ref: '#/components/schemas/PlanChangeAction'
                          - $ref: '#/components/schemas/NoData'
                        description: >-
                          Empty when the plan change completes outright; the
                          authentication payload when the provider requires a
                          3-D Secure challenge.
              example:
                status: ok
                message: ''
                data: []
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  parameters:
    teams:
      name: teams[]
      in: query
      description: >-
        Team scope for the request, as one or more team ObjectIds. The brackets
        are required: PHP keeps only the last value for a repeated plain key, so
        `teams=A&teams=B` silently resolves to B alone. On requests with a JSON
        body you may send `teams` (no brackets) in the body instead.


        **Values that are not valid ObjectIds are silently ignored** — a
        mistyped team ID behaves as if no team was sent. See the [teams section
        of the API conventions guide](/guides/api-conventions#team-scoping).
      style: form
      explode: true
      schema:
        type: array
        items:
          type: string
      example:
        - 64a1b2c3d4e5f6a7b8c9d0ff
  schemas:
    Envelope:
      type: object
      description: The common response envelope shared by all ConveYour endpoints.
      properties:
        status:
          type: string
          enum:
            - ok
            - failed
          description: '`ok` on success, `failed` on error.'
        message:
          type: string
          description: Human-readable description of the result.
        data:
          description: >-
            The response payload — an object or an array depending on the
            endpoint.
    PlanChangeAction:
      type: object
      description: >-
        Returned ONLY when the subscription change needs 3-D Secure
        authentication (requires_action). A plan change that completes without a
        challenge returns an empty data array instead.
      properties:
        billing_action:
          type: string
          description: >-
            Action the client must perform; the authenticate-payment-intent
            constant.
        client_secret:
          type: string
          description: Client secret for the payment intent.
        invoice_id:
          type: string
          description: Invoice awaiting authentication.
        plan_id:
          type: string
          description: The plan that was being applied.
    NoData:
      type: array
      items: {}
      maxItems: 0
      description: No payload — `data` is an empty array.
  responses:
    Forbidden:
      description: >-
        The token is missing or invalid, or the service account behind it lacks
        the permission this endpoint requires.
      content:
        application/json:
          example:
            status: failed
            message: Lacking necessary permission add_contacts
            data:
              permission: add_contacts
  securitySchemes:
    conveyourToken:
      type: apiKey
      in: header
      name: x-conveyour-token
      description: >-
        Your API key token. Contacts endpoints require a **Server-only — Full
        API** key — see [Authentication](/quickstart).

````

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