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

# Create Customer

> Create a customer with given parameters



## OpenAPI

````yaml https://api.getmeasure.com/api/v1/docs/api_spec.json post /companies/{company_id}/customers
openapi: 3.1.0
info:
  title: Measure API
  description: APIs to communicate with Measure
  version: 1.0.0
servers:
  - url: https://api.getmeasure.com/api/v1
security: []
paths:
  /companies/{company_id}/customers:
    post:
      tags:
        - Customers
      summary: Create Customer
      description: Create a customer with given parameters
      operationId: Create_Customer
      parameters:
        - name: company_id
          in: path
          description: 'The company ID with the prefix ''cmp_''. '
          required: true
          schema:
            description: 'The company ID with the prefix ''cmp_''. '
            type: string
        - name: Idempotency-Key
          in: header
          description: >-
            The idempotency key that will be used to ensure the request is only
            performed once
          schema:
            description: >-
              The idempotency key that will be used to ensure the request is
              only performed once
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestCreateCustomerRequest'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseCustomerLiteRepresentation'
      deprecated: false
      security:
        - apiKey:
            - ''
components:
  schemas:
    RequestCreateCustomerRequest:
      properties:
        address:
          description: The address of the customer
          properties:
            address_line_1:
              type: string
            address_line_2:
              type: string
            city:
              type: string
            country:
              description: 2-character country code (ISO 3166-1 alpha-2)
              examples:
                - US
              type: string
            place_id:
              type:
                - 'null'
                - string
            state:
              type: string
            zip:
              type: string
          type:
            - object
            - 'null'
        billing_emails:
          description: The additional emails to cc on customer's invoices
          examples:
            - - harry.potter@hogwarts.com
          format: email
          items:
            type: string
          type:
            - 'null'
            - array
        child_rollup_billing:
          description: Whether to enable rollup billing for children of this account
          type: boolean
        child_rollup_billing_config:
          $ref: '#/components/schemas/ModelChildRollupBillingConfig'
          description: The billing configuration if child rollup billing is enabled
        email:
          description: The email address of the customer
          examples:
            - harry.potter@hogwarts.com
          format: email
          type: string
        exclude_from_metrics:
          description: >-
            Whether to exclude this customer and related fields from any metrics
            in Measure
          type:
            - 'null'
            - boolean
        identifier:
          description: A unique identifier that ties the customer back to your system
          type: string
        locale:
          description: The locale of the customer
          type: string
        metadata:
          additionalProperties: true
          description: >-
            Any additional data as key-value pairs that needs to be attached to
            the customer
          type: object
        name:
          description: The name of the customer
          type: string
        org_name:
          description: The name of the company or organization this customer is a part of
          type: string
        override_taxes:
          description: >-
            Any specific taxes for the customer. These taxes will override any
            automatic tax collections for the customer.
          items:
            $ref: '#/components/schemas/RequestTaxParams'
          type:
            - 'null'
            - array
        owner_id:
          description: >-
            The company user ID of the user in Measure assigned to manage this
            customer
          type:
            - string
            - 'null'
        parent_customer_id:
          description: The parent of this customer account, used for parent-child billing
          type:
            - string
            - 'null'
        phone:
          description: The phone number of the customer
          type: string
        tags:
          description: Any tags that needs to be attached to the customer
          items:
            type: string
          type:
            - 'null'
            - array
        title:
          description: The title of the customer, such as CEO, VP
          type: string
      required:
        - identifier
      type: object
    ResponseCustomerLiteRepresentation:
      properties:
        address:
          $ref: '#/components/schemas/ModelAddress'
          description: The address of the customer
        arr:
          $ref: '#/components/schemas/ModelAmount'
          description: The ARR of the customer
        billing_emails:
          description: The additional emails to cc on customer's invoices
          items:
            type: string
          type:
            - array
            - 'null'
        company_id:
          description: The company ID of the customer
          type: string
        computed_entitlements:
          description: The computed entitlements for the customer
          items:
            $ref: '#/components/schemas/ResponseEntitlementDataRepresentation'
          type:
            - array
            - 'null'
        created_at:
          description: The date the customer was created
          format: date-time
          type: string
        customer_integration_metadata:
          additionalProperties:
            $ref: '#/components/schemas/ModelCustomerIntegrationMetadata'
          type: object
        display_name:
          description: The computed display name of the customer
          type: string
        email:
          description: The email of the customer
          type: string
        exclude_from_metrics:
          description: >-
            Whether to exclude this customer and related fields from any metrics
            in Measure
          type: boolean
        id:
          description: The ID of the customer in Measure
          type: string
        identifier:
          description: >-
            The unique identifier for the customer that ties back to your
            system. You can query for a customer using this identifier
          type: string
        integration_references:
          description: >-
            The integration references of this customer in third-party
            applications connected to Measure
          items:
            $ref: '#/components/schemas/ResponseCustomerIntegrationRefs'
          type: array
        locale:
          description: The locale of the customer
          type: string
        managed_externally:
          description: Whether this customer is managed outside of Measure
          type: boolean
        metadata:
          additionalProperties: true
          description: The metadata as key-value pairs attached to this customer
          type: object
        mrr:
          $ref: '#/components/schemas/ModelAmount'
          description: The MRR of the customer
        name:
          description: The name of the customer
          type: string
        org_name:
          description: >-
            The name of the company or the organization this customer is a part
            of
          type: string
        owner_id:
          description: >-
            The company user ID of person in Measure assigned to manage this
            customer
          type:
            - 'null'
            - string
        parent_customer_id:
          description: The customer ID of the parent customer assigned in Measure
          type:
            - 'null'
            - string
        phone:
          description: The phone number of the customer
          type: string
        status:
          description: The status of the customer such as ACTIVE or ARCHIVED
          type: string
        title:
          description: The title of the customer, such as CEO, VP
          type: string
        updated_at:
          description: The date the customer was last updated
          format: date-time
          type: string
      type: object
    ModelChildRollupBillingConfig:
      description: The configuration for child rollup billing
      properties:
        auto_charges:
          description: >-
            Whether the rollup invoice is automatically charged on the customer
            payment method
          type:
            - 'null'
            - boolean
        end_date:
          description: The last date of the rollup invoice generation
          format: date-time
          type:
            - 'null'
            - string
        frequency:
          description: The frequency at which the rollup invoice is generated
          enum:
            - HOUR
            - DAY
            - WEEK
            - BI_MONTH
            - MONTH
            - QUARTER
            - BI_ANNUAL
            - YEAR
          type:
            - string
        invoice_additional_display_fields:
          description: >-
            Any additional metadata fields to be displayed on the rollup invoice
            such as a PO number, payment details etc.
          items:
            $ref: '#/components/schemas/ModelInvoiceField'
          type:
            - array
            - 'null'
        invoice_due_date_from_creation:
          description: The net terms of the rollup invoice generated
          minimum: 0
          type:
            - 'null'
            - integer
        start_date:
          description: The start date of the rollup invoice generation
          format: date-time
          type:
            - string
      required:
        - frequency
        - start_date
      type:
        - object
        - 'null'
    RequestTaxParams:
      properties:
        country:
          description: The country for the tax. e.g. Canada
          type: string
        description:
          description: The description for the tax
          type: string
        metadata:
          additionalProperties: true
          description: >-
            Any additional data as key-value pairs that needs to be attached to
            the tax
          type: object
        name:
          description: The name for the tax
          type: string
        rate:
          description: The tax rate in decimal, less than 1
          type: number
        region:
          description: The region for the tax. e.g. Ontario
          type: string
        type:
          description: >-
            The type of tax that can be one of GST, HST, VAT, QST, SALES or
            CUSTOM.
          enum:
            - GST
            - HST
            - VAT
            - QST
            - PST
            - SALES
            - CUSTOM
          type: string
      required:
        - name
        - rate
        - type
      type: object
    ModelAddress:
      properties:
        address_line_1:
          type: string
        address_line_2:
          type: string
        city:
          type: string
        country:
          description: 2-character country code (ISO 3166-1 alpha-2)
          examples:
            - US
          type: string
        place_id:
          type:
            - 'null'
            - string
        state:
          type: string
        zip:
          type: string
      type: object
    ModelAmount:
      description: The amount which has value in cents and a currency
      properties:
        currency:
          type: string
        value_in_cents:
          format: int64
          type: integer
      type: object
    ResponseEntitlementDataRepresentation:
      properties:
        entitlement_id:
          type: string
        id:
          type: string
        inherited_from_id:
          type:
            - 'null'
            - string
        inherited_from_type:
          type:
            - 'null'
            - string
        key:
          type: string
        name:
          type: string
        original_value: {}
        overridden:
          type:
            - 'null'
            - boolean
        type:
          type: string
        value: {}
      type: object
    ModelCustomerIntegrationMetadata:
      properties:
        anrok:
          $ref: '#/components/schemas/ModelAnrokCustomerIntegrationMetadata'
        avalara:
          $ref: '#/components/schemas/ModelAvalaraCustomerIntegrationMetadata'
      type: object
    ResponseCustomerIntegrationRefs:
      properties:
        integration_icon:
          type: string
        integration_id:
          type: string
        integration_key:
          type: string
        integration_name:
          type: string
        reference_type:
          type: string
        remote_id:
          type: string
        remote_type:
          type: string
      type: object
    ModelInvoiceField:
      properties:
        name:
          type: string
        value:
          type: string
      type: object
    ModelAnrokCustomerIntegrationMetadata:
      properties:
        vat_id:
          type: string
      type: object
    ModelAvalaraCustomerIntegrationMetadata:
      properties:
        entity_code:
          type: string
      type: object
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer

````