Update DiscountCode

PUT

api

billing

discountcodes

Update DiscountCode

curl --request PUT \
  --url https://spaces.nexudus.com/api/billing/discountcodes \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "BusinessId": 123,
  "Code": "<string>",
  "Description": "<string>"
}
'

import requests

url = "https://spaces.nexudus.com/api/billing/discountcodes"

payload = {
    "Id": 123,
    "BusinessId": 123,
    "Code": "<string>",
    "Description": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({Id: 123, BusinessId: 123, Code: '<string>', Description: '<string>'})
};

fetch('https://spaces.nexudus.com/api/billing/discountcodes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Updates an existing DiscountCode record. You must include the Id of the record to update along with all required fields.

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 DiscountCode-Edit role.

Enums

eDiscountExpirePeriod

Value	Name
1	Day
2	Week
3	Month
4	Year

Request Body

Required Fields

integer

required

The Id of the DiscountCode record to update.

integer

required

ID of the business linked to this record.

string

required

The unique alphanumeric code customers enter to apply the discount.

string

required

Human-readable description of what this discount code is for.

Optional Fields

boolean

Whether this discount code is currently active and can be redeemed.

string

Date from which this discount code is visible/published to customers.

string

Date until which this discount code is visible/published to customers.

number

Percentage discount to apply (e.g. 10 for 10% off). Mutually exclusive with DiscountAmount.

number

Fixed monetary amount to discount. Mutually exclusive with DiscountPercentage.

boolean

Whether this discount code is used as part of the referral program.

boolean

Whether this discount can be applied to price plans (tariffs). When true, use Tariffs to restrict to specific plans.

integer[]

List of tariffs linked to this record.

integer[]

The added tariffs value for this discount code.

integer[]

The removed tariffs value for this discount code.

boolean

Whether this discount can be applied to resource bookings. When true, use ResourceTypes to restrict to specific resource types.

integer[]

List of resource types linked to this record.

integer[]

The added resource types value for this discount code.

integer[]

The removed resource types value for this discount code.

boolean

Whether this discount can be applied to products. When true, use Products to restrict to specific products.

integer[]

List of products linked to this record.

integer[]

The added products value for this discount code.

integer[]

The removed products value for this discount code.

boolean

Whether this discount can be applied to events. When true, use EventCategories to restrict to specific event categories.

integer[]

List of event categories linked to this record.

integer[]

The added event categories value for this discount code.

integer[]

The removed event categories value for this discount code.

integer

Maximum number of times a single customer can redeem this discount code.

integer

Maximum total number of times this discount code can be redeemed across all customers.

boolean

When true, only contacts (non-member customers) can use this discount code.

boolean

When true, only members (customers with an active plan) can use this discount code.

string

Start date from which this discount code can be redeemed.

string

End date after which this discount code can no longer be redeemed.

integer

Unit of the expiration period (Day, Week, Month, Year). Used with ExpiresIn to determine when the discount expires after being assigned to a customer. See eDiscountExpirePeriod? enum above.

integer

Number of ExpirationType periods after assignment until the discount expires for a customer.

Code Examples

curl -X PUT \
  "https://spaces.nexudus.com/api/billing/discountcodes" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "Code": "",
    "Description": "",
    "Id": 87654321
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/discountcodes',
  {
    method: 'PUT',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      BusinessId: 0,
      Code: '',
      Description: '',
      Id: 87654321
    })
  }
);

const data = await response.json();

import requests

response = requests.put(
    'https://spaces.nexudus.com/api/billing/discountcodes',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'Code': '',
        'Description': '',
        'Id': 87654321
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the update.

object

Contains the Id of the updated record.

boolean

true if the discountcode was updated successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "DiscountCode was successfully updated.",
  "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

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

boolean

false when the request fails validation.

Example Response

{
  "Message": "Code: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Code"
    }
  ],
  "WasSuccessful": false
}

Delete DiscountCodeDelete an existing DiscountCode record by its Id.

Update DiscountCode

curl --request PUT \
  --url https://spaces.nexudus.com/api/billing/discountcodes \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "BusinessId": 123,
  "Code": "<string>",
  "Description": "<string>"
}
'

import requests

url = "https://spaces.nexudus.com/api/billing/discountcodes"

payload = {
    "Id": 123,
    "BusinessId": 123,
    "Code": "<string>",
    "Description": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({Id: 123, BusinessId: 123, Code: '<string>', Description: '<string>'})
};

fetch('https://spaces.nexudus.com/api/billing/discountcodes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Enums

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400