> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Create Tariff
> Create a new Tariff record.
## Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the `Authorization` header.
The authenticated user must be a full unrestricted administrator or have the **`Tariff-Create`** role.
## Enums
| Value | Name |
| ----- | --------------------- |
| 1 | FullTimePrivateOffice |
| 2 | PartTimePrivateOffice |
| 3 | FullTimeDedicatedDesk |
| 4 | PartTimeDedicatedDesk |
| 5 | FullTimeHotDesk |
| 6 | PartTimeHotDesk |
| 7 | FullTimeOther |
| 8 | PartTimeOther |
| 9 | Storage |
| 10 | VirtualOffice |
| 11 | Virtual |
| 99 | Other |
| Value | Name |
| ----- | ------------------- |
| 1 | RenewalDate |
| 2 | BookingEndDate |
| 3 | BookingCreationDate |
| 4 | NextNthOfMonth |
| Value | Name |
| ----- | -------------- |
| 1 | Manual |
| 2 | StripeIdentity |
| Value | Name |
| ----- | ------------- |
| 1 | Never |
| 2 | Every3Months |
| 3 | Every6Months |
| 4 | Every12Months |
| 5 | Every24Months |
## Request Body
### Required Fields
Business Id.
Tariff name.
System tariff type. Defaults to `eTariffType.FullTimePrivateOffice`.
Price.
Currency Id.
Cancellation period in days.
Display order.
Invoice every N months.
Invoice every N weeks.
Booking due date strategy. Defaults to `eTariffBookingDueDateStrategy.RenewalDate`.
Address identity check provider. Defaults to `eIdentityCheckProvider.Manual`.
Address identity check repeat pattern. Defaults to `eIdentityCheckRepeatPattern.Never`.
Identity check provider. Defaults to `eIdentityCheckProvider.Manual`.
Identity check repeat pattern. Defaults to `eIdentityCheckRepeatPattern.Never`.
### Optional Fields
Default invoicing day.
Whether the tariff is visible.
Whether to use time passes.
Description.
Invoice line display text.
Sign-up fee.
Tax Rate Id.
Reduced Tax Rate Id.
Exempt Tax Rate Id.
Financial Account Id.
Terms and conditions.
New Contract Document Url.
Clear Contract Document File.
Group name.
Disable portal cancellations.
Subscribers limit.
Cancellation limit in days.
Default contract term in months.
Cancel member account after days.
Check-in price plan limit.
Check-in month limit.
Check-in week limit.
Visitor month limit.
Visitor week limit.
Visitor day limit.
Hours price plan limit.
Hours month limit.
Hours week limit.
Booking minute week limit.
Booking minute month limit.
Discount percentage for extra services.
Discount percentage for time passes.
Discount percentage for charges.
Auto cancel after days.
Advance invoice cycles.
Prorate day of month.
Prorate days before.
Prorate cancellations.
Charge and extend days.
Exclude From Invoice.
Auto raise invoices.
Raise invoice every N months.
Raise invoice every N weeks.
Minimum price.
Include time passes in minimum price.
Include extra services in minimum price.
Include events in minimum price.
Whether the tariff is archived.
Whether the tariff is starred.
Keep new accounts on hold.
Whether the tariff can be paused.
Pause yearly limit.
Pause cycles limit.
Booking due date day of month.
Whether this is a virtual office tariff.
Request address identity check.
Address identity check description.
Keep paused if address mismatch.
Request identity check.
Identity check description.
Send onboarding form by email.
Form Page Id.
Products Store.
Products Forward.
Products Recycle.
Products Shred.
Products Scan.
Products Return.
Products Deposit.
Products Collect.
Delivery preferences for mail.
Delivery preferences for parcels.
Delivery preferences for checks.
Delivery preferences for publicity.
Delivery preferences for other.
Maximum delivery storage days.
Maximum company aliases.
Maximum recipients.
Maximum addresses.
Transfer products to contract.
## Code Examples
```bash cURL theme={null}
curl -X POST \
"https://spaces.nexudus.com/api/billing/tariffs" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"BusinessId": 0,
"Name": "",
"SystemTariffType": 0,
"Price": 0,
"CurrencyId": 0,
"CancellationPeriod": 0,
"DisplayOrder": 0,
"InvoiceEvery": 0,
"InvoiceEveryWeeks": 0,
"BookingDueDateStrategy": 0,
"AddressIdentityCheckProvider": 0,
"AddressIdentityCheckRepeatPattern": 0,
"IdentityCheckProvider": 0,
"IdentityCheckRepeatPattern": 0
}'
```
```javascript JavaScript theme={null}
const response = await fetch(
'https://spaces.nexudus.com/api/billing/tariffs',
{
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_TOKEN',
'Content-Type': 'application/json'
},
body: JSON.stringify({
BusinessId: 0,
Name: '',
SystemTariffType: 0,
Price: 0,
CurrencyId: 0,
CancellationPeriod: 0,
DisplayOrder: 0,
InvoiceEvery: 0,
InvoiceEveryWeeks: 0,
BookingDueDateStrategy: 0,
AddressIdentityCheckProvider: 0,
AddressIdentityCheckRepeatPattern: 0,
IdentityCheckProvider: 0,
IdentityCheckRepeatPattern: 0
})
}
);
const data = await response.json();
```
```python Python theme={null}
import requests
response = requests.post(
'https://spaces.nexudus.com/api/billing/tariffs',
headers={
'Authorization': 'Bearer YOUR_TOKEN',
'Content-Type': 'application/json'
},
json={
'BusinessId': 0,
'Name': '',
'SystemTariffType': 0,
'Price': 0,
'CurrencyId': 0,
'CancellationPeriod': 0,
'DisplayOrder': 0,
'InvoiceEvery': 0,
'InvoiceEveryWeeks': 0,
'BookingDueDateStrategy': 0,
'AddressIdentityCheckProvider': 0,
'AddressIdentityCheckRepeatPattern': 0,
'IdentityCheckProvider': 0,
'IdentityCheckRepeatPattern': 0
}
)
data = response.json()
```
## Response
### 200
HTTP status code. `200` on success.
A human-readable message confirming the creation.
Contains the `Id` of the newly created record.
`true` if the tariff was created successfully.
`null` on success.
```json Example Response theme={null}
{
"Status": 200,
"Message": "Tariff was successfully created.",
"Value": {
"Id": 87654321
},
"OpenInDialog": false,
"OpenInWindow": false,
"RedirectURL": null,
"JavaScript": null,
"UpdatedOn": "2025-01-15T10:30:00Z",
"UpdatedBy": "admin@example.com",
"Errors": null,
"WasSuccessful": true
}
```
### 400
A summary of the validation error(s), in the format `PropertyName: error message`.
`null` on validation failure.
Array of validation errors.
The value that was submitted for the field, or `null` if missing.
The validation error message.
The name of the property that failed validation.
`false` when the request fails validation.
```json Example Response theme={null}
{
"Message": "Name: is a required field",
"Value": null,
"Errors": [
{
"AttemptedValue": null,
"Message": "is a required field",
"PropertyName": "Name"
}
],
"WasSuccessful": false
}
```