> ## 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.

# Create usages

> Records one usage, or several in one call, against a metered order line.

Send one usage as an object under `usage`, or several as a list under `usages`. `charge_item_id` is the `id` of an order line whose item is charged as `METERED`, and `charging_period` names the billing period the usage falls in. For several usages the response lists each one under `usages.success` or `usages.failed`.

> [!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 /usages
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:
  /usages:
    post:
      tags:
        - Usages
      summary: Create usages
      description: >-
        Send one usage as an object under `usage`, or several as a list under
        `usages`. `charge_item_id` is the `id` of an order line whose item is
        charged as `METERED`, and `charging_period` names the billing period the
        usage falls in. For several usages the response lists each one under
        `usages.success` or `usages.failed`.
      operationId: usages_create_usage
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: >-
                Send one usage as an object under `usage`, or several as a list
                under `usages`.
              properties:
                usage:
                  type: object
                  properties:
                    charge_item_id:
                      type: string
                      description: >-
                        The `id` of the order line that bills the usage. The
                        line's item must be charged as `METERED`.
                    charging_period:
                      type: string
                      description: >-
                        The billing period the usage falls in, as `<start
                        date>-<end date>`, such as `2026-10-01-2026-10-31`.
                    quantity:
                      type: number
                    start_time:
                      type: string
                      description: >-
                        When the usage started, in UTC, such as
                        `2026-10-01T09:00:00Z`.
                    end_time:
                      type: string
                      description: When the usage ended, in UTC.
                    type:
                      type: string
                      description: Such as `INCREMENTAL`.
                usages:
                  type: array
                  items:
                    type: object
                    properties:
                      charge_item_id:
                        type: string
                        description: >-
                          The `id` of the order line that bills the usage. The
                          line's item must be charged as `METERED`.
                      charging_period:
                        type: string
                        description: >-
                          The billing period the usage falls in, as `<start
                          date>-<end date>`, such as `2026-10-01-2026-10-31`.
                      quantity:
                        type: number
                      start_time:
                        type: string
                        description: >-
                          When the usage started, in UTC, such as
                          `2026-10-01T09:00:00Z`.
                      end_time:
                        type: string
                        description: When the usage ended, in UTC.
                      type:
                        type: string
                        description: Such as `INCREMENTAL`.
            example:
              usage:
                charge_item_id: 6f1d2c3b-4a5e-4f60-8b7c-9d0e1f2a3b4c
                charging_period: 2026-10-01-2026-10-31
                quantity: 1
                start_time: '2026-10-01T09:00:00Z'
                end_time: '2026-10-01T09:05:00Z'
                type: INCREMENTAL
      responses:
        '201':
          description: >-
            The new usage under `usage`, or the outcome of each one under
            `usages`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageCreateResponse'
        '400':
          description: '`usage` holds a list. Send several usages under `usages` instead.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-codeSamples:
        - lang: bash
          label: cURL
          source: |-
            curl -X POST "$EXSITED_BASE_URL/api/v4/usages" \
              -H "Authorization: Bearer $ACCESS_TOKEN" \
              -H "Content-Type: application/json" \
              -d '{
                "usage": {
                  "charge_item_id": "6f1d2c3b-4a5e-4f60-8b7c-9d0e1f2a3b4c",
                  "charging_period": "2026-10-01-2026-10-31",
                  "quantity": 1,
                  "start_time": "2026-10-01T09:00:00Z",
                  "end_time": "2026-10-01T09:05:00Z",
                  "type": "INCREMENTAL"
                }
              }'
        - lang: python
          label: Python
          source: |
            from exsited import build_client

            client = build_client()

            response = client.usages.create_usage(
                {
                    "usage": {
                        "charge_item_id": "6f1d2c3b-4a5e-4f60-8b7c-9d0e1f2a3b4c",
                        "charging_period": "2026-10-01-2026-10-31",
                        "quantity": 1,
                        "start_time": "2026-10-01T09:00:00Z",
                        "end_time": "2026-10-01T09:05:00Z",
                        "type": "INCREMENTAL",
                    }
                }
            )
            print(response.data)
        - lang: javascript
          label: JavaScript
          source: |
            import {buildClient} from 'exsited';

            const client = await buildClient();

            const response = await client.usages.createUsage({
                usage: {
                    charge_item_id: '6f1d2c3b-4a5e-4f60-8b7c-9d0e1f2a3b4c',
                    charging_period: '2026-10-01-2026-10-31',
                    quantity: 1,
                    start_time: '2026-10-01T09:00:00Z',
                    end_time: '2026-10-01T09:05:00Z',
                    type: 'INCREMENTAL',
                },
            });
            console.log(response.data);
        - lang: php
          label: PHP
          source: |
            use Exsited\Client\ClientRegistry;

            $client = ClientRegistry::buildClient();

            $response = $client->usages->createUsage([
                'usage' => [
                    'charge_item_id' => '6f1d2c3b-4a5e-4f60-8b7c-9d0e1f2a3b4c',
                    'charging_period' => '2026-10-01-2026-10-31',
                    'quantity' => 1,
                    'start_time' => '2026-10-01T09:00:00Z',
                    'end_time' => '2026-10-01T09:05:00Z',
                    'type' => 'INCREMENTAL',
                ],
            ]);
            print_r($response->data);
        - lang: java
          label: Java
          source: >
            import com.exsited.client.ApiResponse;

            import com.exsited.client.ClientRegistry;

            import com.exsited.client.ExsitedClient;

            import com.exsited.resources.usages.usages_dto.UsagesDto;

            import java.util.Map;


            ExsitedClient client = ClientRegistry.buildClient();


            ApiResponse<UsagesDto.Usages> response =
            client.usages().createUsage(
                    Map.of(
                            "usage", Map.of(
                                    "charge_item_id", "6f1d2c3b-4a5e-4f60-8b7c-9d0e1f2a3b4c",
                                    "charging_period", "2026-10-01-2026-10-31",
                                    "quantity", 1,
                                    "start_time", "2026-10-01T09:00:00Z",
                                    "end_time", "2026-10-01T09:05:00Z",
                                    "type", "INCREMENTAL")));
            System.out.println(response.getMap());
        - lang: csharp
          label: .NET
          source: >
            using Exsited.Client;


            await using var client = ExsitedClient.BuildClient();


            var response = await client.Usages.CreateUsageAsync(new
            Dictionary<string, object?>

            {
                ["usage"] = new Dictionary<string, object?>
                {
                    ["charge_item_id"] = "6f1d2c3b-4a5e-4f60-8b7c-9d0e1f2a3b4c",
                    ["charging_period"] = "2026-10-01-2026-10-31",
                    ["quantity"] = 1,
                    ["start_time"] = "2026-10-01T09:00:00Z",
                    ["end_time"] = "2026-10-01T09:05:00Z",
                    ["type"] = "INCREMENTAL",
                },
            });


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

            final client = buildClient();

            final response = await client.usages.createUsage({
              'usage': {
                'charge_item_id': '6f1d2c3b-4a5e-4f60-8b7c-9d0e1f2a3b4c',
                'charging_period': '2026-10-01-2026-10-31',
                'quantity': 1,
                'start_time': '2026-10-01T09:00:00Z',
                'end_time': '2026-10-01T09:05:00Z',
                'type': 'INCREMENTAL',
              },
            });
            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.Usages().CreateUsage(context.Background(), map[string]any{\n\t\"usage\": map[string]any{\n\t\t\"charge_item_id\":  \"6f1d2c3b-4a5e-4f60-8b7c-9d0e1f2a3b4c\",\n\t\t\"charging_period\": \"2026-10-01-2026-10-31\",\n\t\t\"quantity\":        1,\n\t\t\"start_time\":      \"2026-10-01T09:00:00Z\",\n\t\t\"end_time\":        \"2026-10-01T09:05:00Z\",\n\t\t\"type\":            \"INCREMENTAL\",\n\t},\n}, nil)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Println(response.Map)\n"
components:
  schemas:
    UsageCreateResponse:
      type: object
      properties:
        usage:
          $ref: '#/components/schemas/UsageCreated'
        usages:
          $ref: '#/components/schemas/UsageBatch'
      description: '`usage` when one usage was sent, `usages` when several were.'
    Error:
      type: object
      description: Every failed call returns this body.
      properties:
        object:
          type: string
          description: Always `error`.
        request_id:
          type: string
          description: Quote this to support.
        status:
          type: integer
          description: The HTTP status.
        code:
          type: string
          description: What went wrong, such as `validation_error`.
        message:
          type: string
          description: A short description of the problem.
        doc_url:
          type: string
          description: A link to more about this error.
        errors:
          type: array
          description: One entry per field that failed.
          items:
            type: object
            properties:
              field:
                type: string
              code:
                type: string
              message:
                type: string
              doc_url:
                type: string
    UsageCreated:
      type: object
      properties:
        object:
          type: string
        id:
          type: string
        event_id:
          type: string
        href:
          type: string
        activity_logs:
          type: array
    UsageBatch:
      type: object
      properties:
        activity_logs:
          type: array
        failed:
          type: array
          items:
            $ref: '#/components/schemas/UsageBatchFailed'
        success:
          type: array
          items:
            $ref: '#/components/schemas/UsageBatchSuccess'
    UsageBatchFailed:
      type: object
      properties:
        charge_item_id:
          type: string
        charging_period:
          type: string
        error:
          type: object
    UsageBatchSuccess:
      type: object
      properties:
        href:
          type: string
        id:
          type: string
        object:
          type: string
  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.