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

# Downgrade an order

> Moves a contract's lines to a lower package from a date.

Send `effective_date` and `lines` at the top level of the body, not under `order`. Each line names its `charge_item_uuid` and the `package_name` to move to.

> [!NOTE]
>
> The SDK samples get their client from credentials your app registers once when it starts, as shown in [Authentication](https://exsited.mintlify.site/authentication.md#set-up-a-client). To try the call here, click **Try it**, set `host` to your Exsited API host name and paste an access token from [Get an access token](https://exsited.mintlify.site/api-reference/authentication/get-an-access-token.md). To send a raw JSON body instead of filling in fields, copy the cURL sample and edit its `-d` payload.


## OpenAPI

````yaml POST /orders/{order_id}/downgrade
openapi: 3.1.0
info:
  title: Exsited API
  version: v4
servers:
  - url: https://{host}/api/v4
    variables:
      host:
        default: your-api-host.example.com
        description: Your Exsited API host name, without https://.
security:
  - bearerAuth: []
tags:
  - name: Authentication
  - name: Accounts
  - name: Account emails
  - name: Account groups
  - name: Communications
  - name: Communication profiles
  - name: Orders
  - name: Quote orders
  - name: Express
  - name: Usages
  - name: Sales reps
  - name: Gift certificates
  - name: Invoices
  - name: Pro-forma invoices
  - name: Payments
  - name: Refunds
  - name: Credit notes
  - name: Credit note applications
  - name: Reconciliations
  - name: Items
  - name: Inventory adjustments
  - name: Units of measurement
  - name: Zones
  - name: Shipping packages
  - name: Shipping rules
  - name: Fulfillment profiles
  - name: Fulfillment terms
  - name: Item fulfillments
  - name: Item receipts
  - name: Bookings
  - name: Rental assets
  - name: Return merchandise authorisations
  - name: Purchase orders
  - name: Purchase invoices
  - name: Purchase payments
  - name: Purchase refunds
  - name: Purchase credit notes
  - name: Purchase credit note applications
  - name: Purchase express
  - name: Return vendor authorizations
  - name: ABA files
  - name: Receive terms
  - name: Labours
  - name: Tasks
  - name: Timesheets
  - name: Milestones
  - name: Employees
  - name: Departments
  - name: Designations
  - name: Teams
  - name: Time periods
  - name: Workflows
  - name: Workflow settings
  - name: Events
  - name: Custom events
  - name: System events
  - name: Approvals
  - name: Approval profiles
  - name: Approval user groups
  - name: Alerts
  - name: Alert responsibility settings
  - name: Alert responsibilities
  - name: Action scripts
  - name: Note groups
  - name: Note attachments
  - name: Instance settings
  - name: Accounting codes
  - name: Additional codes
  - name: Billing periods
  - name: Charging periods
  - name: Pricing periods
  - name: Invoice terms
  - name: Days of the month
  - name: Countries
  - name: Salutations
  - name: Document templates
  - name: Email templates
  - name: Roles
  - name: Operators
  - name: Operator groups
  - name: User settings
  - name: Custom attributes
  - name: Custom components
  - name: Custom features
  - name: Custom fields
  - name: Custom forms
  - name: Attribute attachments
  - name: Portal
  - name: Integration connections
  - name: External databases
  - name: Reports
  - name: Applications
  - name: Organisation
  - name: Child organisations
  - name: Webhooks
paths:
  /orders/{order_id}/downgrade:
    post:
      tags:
        - Orders
      summary: Downgrade an order
      description: >-
        Send `effective_date` and `lines` at the top level of the body, not
        under `order`. Each line names its `charge_item_uuid` and the
        `package_name` to move to.
      operationId: orders_downgrade_order
      parameters:
        - name: order_id
          in: path
          required: true
          description: The order's `id`, as `GET /orders` lists it.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                effective_date:
                  type: string
                  description: As `YYYY-MM-DD`.
                lines:
                  type: array
                  items:
                    type: object
                    properties:
                      charge_item_uuid:
                        type: string
                        description: The line's `charge_item_uuid`.
                      package_name:
                        type: string
                        description: The package to move the line to.
              description: 'Not wrapped: the fields go at the top level of the body.'
            example:
              effective_date: '2026-10-01'
              lines:
                - charge_item_uuid: 0c9b8a7d-6e5f-4a3b-9c2d-1e0f9a8b7c6d
                  package_name: Basic
      responses:
        '200':
          description: The order is downgraded.
      x-codeSamples:
        - lang: bash
          label: cURL
          source: |-
            curl -X POST "$EXSITED_BASE_URL/api/v4/orders/ORD-0001/downgrade" \
              -H "Authorization: Bearer $ACCESS_TOKEN" \
              -H "Content-Type: application/json" \
              -d '{
                "effective_date": "2026-10-01",
                "lines": [
                  {
                    "charge_item_uuid": "0c9b8a7d-6e5f-4a3b-9c2d-1e0f9a8b7c6d",
                    "package_name": "Basic"
                  }
                ]
              }'
        - lang: python
          label: Python
          source: |
            from exsited import build_client

            client = build_client()

            response = client.orders.downgrade_order(
                "ORD-0001",
                {
                    "effective_date": "2026-10-01",
                    "lines": [
                        {
                            "charge_item_uuid": "0c9b8a7d-6e5f-4a3b-9c2d-1e0f9a8b7c6d",
                            "package_name": "Basic",
                        }
                    ],
                },
            )
            print(response.data)
        - lang: javascript
          label: JavaScript
          source: |
            import {buildClient} from 'exsited';

            const client = await buildClient();

            const response = await client.orders.downgradeOrder('ORD-0001', {
                effective_date: '2026-10-01',
                lines: [{charge_item_uuid: '0c9b8a7d-6e5f-4a3b-9c2d-1e0f9a8b7c6d', package_name: 'Basic'}],
            });
            console.log(response.data);
        - lang: php
          label: PHP
          source: |
            use Exsited\Client\ClientRegistry;

            $client = ClientRegistry::buildClient();

            $response = $client->orders->downgradeOrder('ORD-0001', [
                'effective_date' => '2026-10-01',
                'lines' => [
                    ['charge_item_uuid' => '0c9b8a7d-6e5f-4a3b-9c2d-1e0f9a8b7c6d', 'package_name' => 'Basic'],
                ],
            ]);
            print_r($response->data);
        - lang: java
          label: Java
          source: |
            import com.exsited.Dto;
            import com.exsited.client.ApiResponse;
            import com.exsited.client.ClientRegistry;
            import com.exsited.client.ExsitedClient;
            import java.util.List;
            import java.util.Map;

            ExsitedClient client = ClientRegistry.buildClient();

            ApiResponse<Dto> response = client.orders().downgradeOrder(
                    "ORD-0001",
                    Map.of(
                            "effective_date", "2026-10-01",
                            "lines", List.of(
                                    Map.of(
                                            "charge_item_uuid", "0c9b8a7d-6e5f-4a3b-9c2d-1e0f9a8b7c6d",
                                            "package_name", "Basic"))));
            System.out.println(response.getMap());
        - lang: csharp
          label: .NET
          source: |
            using Exsited.Client;

            await using var client = ExsitedClient.BuildClient();

            var response = await client.Orders.DowngradeOrderAsync(
                "ORD-0001",
                new Dictionary<string, object?>
                {
                    ["effective_date"] = "2026-10-01",
                    ["lines"] = new List<object?>
                    {
                        new Dictionary<string, object?>
                        {
                            ["charge_item_uuid"] = "0c9b8a7d-6e5f-4a3b-9c2d-1e0f9a8b7c6d",
                            ["package_name"] = "Basic",
                        },
                    },
                });

            Console.WriteLine(response.Json);
        - lang: dart
          label: Dart
          source: |
            import 'package:exsited/exsited.dart';

            final client = buildClient();

            final response = await client.orders.downgradeOrder('ORD-0001', {
              'effective_date': '2026-10-01',
              'lines': [
                {
                  'charge_item_uuid': '0c9b8a7d-6e5f-4a3b-9c2d-1e0f9a8b7c6d',
                  'package_name': 'Basic',
                },
              ],
            });
            print(response.map);
        - lang: go
          label: Go
          source: "import (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\n\texsited \"github.com/exsited/exsited-sdk-go/v4\"\n)\n\nclient, err := exsited.BuildClient(nil)\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer client.Close()\n\nresponse, err := client.Orders().DowngradeOrder(context.Background(), \"ORD-0001\", map[string]any{\n\t\"effective_date\": \"2026-10-01\",\n\t\"lines\": []any{\n\t\tmap[string]any{\n\t\t\t\"charge_item_uuid\": \"0c9b8a7d-6e5f-4a3b-9c2d-1e0f9a8b7c6d\",\n\t\t\t\"package_name\":     \"Basic\",\n\t\t},\n\t},\n}, nil)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Println(response.Map)\n"
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An access token from `POST /api/v4/oauth2/token`. The SDKs get and renew
        it for you.

````

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