Skip to main content
POST
/
companies
Create Company
curl --request POST \
  --url https://api.nuwebgroup.com/v1/partner/companies \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-NU-RESELLER-ID: <x-nu-reseller-id>' \
  --data '
{
  "name": "Global Ticket Site",
  "alias": "globaltickets",
  "currencies": [
    "GBP",
    "USD"
  ],
  "countries": [
    "GB"
  ],
  "languages": [
    "en"
  ],
  "gateways": [
    "stripe"
  ],
  "features": [],
  "fees": [
    {
      "currency": "GBP",
      "typeId": 1,
      "salesPointTypeId": 1,
      "bands": [
        {
          "rangeMin": 1,
          "rangeMax": null,
          "fixed": 100,
          "percent": 0,
          "min": null,
          "max": null
        }
      ]
    }
  ],
  "timezone": "Europe/London",
  "trialExpiresAt": "2023-04-01 00:00:00"
}
'
{
  "data": {
    "type": "companies",
    "id": 9999,
    "attributes": {
      "name": "Global Ticket Site",
      "alias": "globaltickets",
      "createdAt": "2023-04-01T13:12:11.000000Z",
      "updatedAt": "2023-04-01T13:12:11.000000Z",
      "deletedAt": null
    }
  }
}

Authorizations

​
Authorization
string
header
required

The 'Bearer' token can be obtained from the token management interface or via the login endpoint using your hub user credentials.

Headers

​
X-NU-RESELLER-ID
integer
required

The ID of the reseller this operation should be performed against.

Body

application/json

Request body for creating a company.

​
name
string
required
​
alias
string
required

This must be a unique, DNS compatible alias used to generate a subdomain for the company.

​
currencies
string[]
required

An array of ISO_4217 currency codes to be enabled for the company. e.g. GBP, USD, MXN etc.

​
countries
string[]
required

An array of ISO 3166 alpha-2 country codes to be enabled for the company. e.g. GB, US, MX etc.

​
languages
string[]
required

An array of locale codes to be enabled for the company. e.g. en, en_US, es_MX etc.

​
timezone
string
required

Default timezone for the company.

Example:

"Europe/London"

​
gateways
string[]

An array of gateway slugs to be enabled for the company.

​
fees
object[]

An array of usage fees to be applied to transactions within this company. You should provide fees for each combination of currency, item type and sales point you want fees to be applied to.

​
features
any[]

An array of slugs for features to be enabled for this company. A full list of available features can be retrieved via the Available features endpoint. Alternatively, passing * here will enable all available features for the company.

​
parent
object

Parent company options. May not be used in combination with children.

​
children
object[]

Companies to associate as children of the company being created. May not be used in combination with parent.

​
dashboardUrl
string

Optionally, a default admin URL which users will be redirected to upon login.

Example:

"/events"

​
copyEventsLimit
integer

The maximum number of additional dates an organiser can setup for an event at one time, applicable to recursive and copy events. Defaults to 31, max 60.

​
eventTimeslotsLimit
integer

The maximum number of timeslots permissible in a single event. Defaults to 30, max 100.

​
billingName
string
​
billingAddress
string
​
salesTaxNumber
string
​
apiAccessType
enum<string>

By default, company API access is disabled. To enable the API for this company, pass one of the below options. Note, to enable this feature, your reseller account must have access to the api_access company feature.

Available options:
none,
read_only,
read_write
​
apiRateLimit
integer

The max number of requests that can be made within a 60s period.

​
trialExpiresAt
string

Response

Successfully created the company.

​
data
object