---
title: "Create an entity"
method: POST
path: "/entities"
tags: ["Entities"]
---

# Create an entity

`POST /entities`

## Request

- Base URL: `https://api.app.subskribe.com`
- URL: `https://api.app.subskribe.com/entities`
- Auth: API key in header `X-API-Key`

Create an entity. On success return the created entity.

## Request body

- EntityJson
  - `entityId` string
  - `displayId` string
  - `name` string, required
  - `prorationScheme` 'FIXED_DAYS' | 'CALENDAR_DAYS', required
  - `prorationMode` 'NORMALIZED' | 'EXACT_DAYS' | 'EXACT', required
  - `invoiceConfigId` string
  - `invoiceConfig` NumberConfig
    - `configId` string
    - `scheme` 'SEQUENCE' | 'PSEUDO_RANDOM'
    - `prefix` string
    - `length` integer
    - `nextSequenceNumber` integer
  - `creditMemoConfig` NumberConfig
    - `configId` string
    - `scheme` 'SEQUENCE' | 'PSEUDO_RANDOM'
    - `prefix` string
    - `length` integer
    - `nextSequenceNumber` integer
  - `timezone` string
  - `functionalCurrency` string, required
  - `wireInstruction` string
  - `companyContact` CompanyContactJson
    - `firstName` string
    - `lastName` string
    - `email` string
    - `phoneNumber` string
    - `address` AccountAddressJson, required
      - `streetAddressLine1` string: Address Line 1 of the Contact
      - `streetAddressLine2` string: Address Line 2 of the Contact
      - `streetAddressLine3` string: Address Line 3 of the Contact
      - `city` string: City of the Contact
      - `state` string: State Code of the Contact (ISO 3166-2 state/province code). Currently supported for USA, Canada. For instance, for Arizona (USA), set state as AZ (not US-AZ).For British Columbia (Canada), set as BC (not CA-BC)
      - `country` string: Country Code of the Contact ( ISO 3166 alpha-2 country code).
      - `zipcode` string: Zip or Postal Code of the Contact
  - `accountReceivableContact` AccountReceivableContactJson
    - `firstName` string
    - `lastName` string
    - `email` string
    - `phoneNumber` string
    - `address` AccountAddressJson, required
      - `streetAddressLine1` string: Address Line 1 of the Contact
      - `streetAddressLine2` string: Address Line 2 of the Contact
      - `streetAddressLine3` string: Address Line 3 of the Contact
      - `city` string: City of the Contact
      - `state` string: State Code of the Contact (ISO 3166-2 state/province code). Currently supported for USA, Canada. For instance, for Arizona (USA), set state as AZ (not US-AZ).For British Columbia (Canada), set as BC (not CA-BC)
      - `country` string: Country Code of the Contact ( ISO 3166 alpha-2 country code).
      - `zipcode` string: Zip or Postal Code of the Contact
  - `erpId` string

## Response `default`

successful operation

---

[API](https://skmtc.dev/dealhub/apis/subskribe-api.md) - [All operations](https://skmtc.dev/dealhub/apis/subskribe-api/llms.txt) - [OpenAPI document](https://skmtc.dev/dealhub/apis/subskribe-api/revisions/c1ee531b82ce?raw)