Discounts

Base URL: https://api.cornerspot.net

Authentication: requests use a bearer token, for example Authorization: Bearer YOUR_API_KEY.

List discounts

GET /c/api/v1/discounts

Returns a paginated, filterable list of the team's reusable discount definitions. Requires the discounts_read scope.

Query parameters

FIELD	TYPE	DESCRIPTION
`query`	string	Full-text search over name and description.
`filter[active]`	boolean	Filter by active/inactive status.
`filter[discount_type]`	string one of `percentage`, `fixed`	Filter to a single discount type (`percentage` or `fixed`).
`filter[search]`	string	Alias for `query` — full-text search over name and description.
`sort`	string	Sort column, `-` prefix for descending. One of name, discount_type, rate, amount, active, position, created_at, updated_at. Default is list order.
`page`	integer	1-based page number.
`per_page`	integer	Page size (1–100, default 25).

Code samples

curl --request GET \
  --url 'https://api.cornerspot.net/c/api/v1/discounts' \
  --header 'Authorization: Bearer YOUR_API_KEY'

const response = await fetch('https://api.cornerspot.net/c/api/v1/discounts', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});

const data = await response.json();
console.log(data);

// Node.js 18+ (native fetch)
const response = await fetch('https://api.cornerspot.net/c/api/v1/discounts', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});

if (!response.ok) {
  throw new Error(`Request failed: ${response.status}`);
}

const data = await response.json();
console.log(data);

import json
import urllib.request

url = "https://api.cornerspot.net/c/api/v1/discounts"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}

request = urllib.request.Request(url, headers=headers, method="GET")

with urllib.request.urlopen(request) as response:
    data = json.loads(response.read().decode("utf-8"))
    print(data)

require "json"
require "net/http"

uri = URI("https://api.cornerspot.net/c/api/v1/discounts")

request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer YOUR_API_KEY"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts JSON.parse(response.body)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.cornerspot.net/c/api/v1/discounts',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_API_KEY',
    ],
]);

$response = curl_exec($curl);
curl_close($curl);

$data = json_decode($response, true);
print_r($data);

Responses

STATUS	DESCRIPTION
`200` OK	a page of discounts
`401` Unauthorized	missing or invalid API key
`403` Forbidden	the key lacks the discounts_read scope

Create a discount

POST /c/api/v1/discounts

Creates a new reusable discount definition. name and discount_type are required. For percentage discounts, rate must be between 0 and 100. Requires discounts_write.

Request body

FIELD	TYPE	DESCRIPTION
`discount`	object
`discount.name`	string · required	Required — display name.
`discount.discount_type`	string · required one of `percentage`, `fixed`	Required — `percentage` or `fixed`.
`discount.rate`	string	Percentage rate (0–100) as a decimal string. Required (and only valid) when `discount_type` is `percentage`.
`discount.amount`	string	Fixed monetary amount as a decimal string. Used when `discount_type` is `fixed`.
`discount.description`	string	Optional free-text description shown on invoices.
`discount.active`	boolean	Defaults to true.
`discount.position`	integer	Display order (acts_as_list). Auto-appended if omitted.

Code samples

curl --request POST \
  --url 'https://api.cornerspot.net/c/api/v1/discounts' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --data '{
  "discount": {
    "name": "string",
    "discount_type": "percentage",
    "rate": "string",
    "amount": "string",
    "description": "string",
    "active": true,
    "position": 1
  }
}'

const response = await fetch('https://api.cornerspot.net/c/api/v1/discounts', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_API_KEY'
  },
  body: JSON.stringify({
    "discount": {
      "name": "string",
      "discount_type": "percentage",
      "rate": "string",
      "amount": "string",
      "description": "string",
      "active": true,
      "position": 1
    }
  })
});

const data = await response.json();
console.log(data);

// Node.js 18+ (native fetch)
const response = await fetch('https://api.cornerspot.net/c/api/v1/discounts', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_API_KEY'
  },
  body: JSON.stringify({
    "discount": {
      "name": "string",
      "discount_type": "percentage",
      "rate": "string",
      "amount": "string",
      "description": "string",
      "active": true,
      "position": 1
    }
  })
});

if (!response.ok) {
  throw new Error(`Request failed: ${response.status}`);
}

const data = await response.json();
console.log(data);

import json
import urllib.request

url = "https://api.cornerspot.net/c/api/v1/discounts"
payload = json.dumps({
  "discount": {
    "name": "string",
    "discount_type": "percentage",
    "rate": "string",
    "amount": "string",
    "description": "string",
    "active": true,
    "position": 1
  }
}).encode("utf-8")
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer YOUR_API_KEY",
}

request = urllib.request.Request(url, data=payload, headers=headers, method="POST")

with urllib.request.urlopen(request) as response:
    data = json.loads(response.read().decode("utf-8"))
    print(data)

require "json"
require "net/http"

uri = URI("https://api.cornerspot.net/c/api/v1/discounts")

request = Net::HTTP::Post.new(uri)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer YOUR_API_KEY"
request.body = JSON.generate({
  "discount": {
    "name": "string",
    "discount_type": "percentage",
    "rate": "string",
    "amount": "string",
    "description": "string",
    "active": true,
    "position": 1
  }
})

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts JSON.parse(response.body)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.cornerspot.net/c/api/v1/discounts',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Content-Type: application/json',
        'Authorization: Bearer YOUR_API_KEY',
    ],
    CURLOPT_POSTFIELDS => json_encode([
    'discount' => [
        'name' => 'string',
        'discount_type' => 'percentage',
        'rate' => 'string',
        'amount' => 'string',
        'description' => 'string',
        'active' => true,
        'position' => 1,
    ],
]),
]);

$response = curl_exec($curl);
curl_close($curl);

$data = json_decode($response, true);
print_r($data);

Responses

STATUS	DESCRIPTION
`201` Created	created
`401` Unauthorized	missing or invalid API key
`403` Forbidden	the key lacks the discounts_write scope
`422` Unprocessable Content	validation errors (e.g. missing name or invalid rate)

Get a discount

GET /c/api/v1/discounts/{id}

Path parameters

FIELD	TYPE	DESCRIPTION
`id`	string · required	Discount definition id.

Code samples

curl --request GET \
  --url 'https://api.cornerspot.net/c/api/v1/discounts/abc123' \
  --header 'Authorization: Bearer YOUR_API_KEY'

const response = await fetch('https://api.cornerspot.net/c/api/v1/discounts/abc123', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});

const data = await response.json();
console.log(data);

// Node.js 18+ (native fetch)
const response = await fetch('https://api.cornerspot.net/c/api/v1/discounts/abc123', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});

if (!response.ok) {
  throw new Error(`Request failed: ${response.status}`);
}

const data = await response.json();
console.log(data);

import json
import urllib.request

url = "https://api.cornerspot.net/c/api/v1/discounts/abc123"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}

request = urllib.request.Request(url, headers=headers, method="GET")

with urllib.request.urlopen(request) as response:
    data = json.loads(response.read().decode("utf-8"))
    print(data)

require "json"
require "net/http"

uri = URI("https://api.cornerspot.net/c/api/v1/discounts/abc123")

request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer YOUR_API_KEY"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts JSON.parse(response.body)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.cornerspot.net/c/api/v1/discounts/abc123',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_API_KEY',
    ],
]);

$response = curl_exec($curl);
curl_close($curl);

$data = json_decode($response, true);
print_r($data);

Responses

STATUS	DESCRIPTION
`200` OK	the discount
`401` Unauthorized	missing or invalid API key
`403` Forbidden	the key lacks the discounts_read scope
`404` Not Found	no such discount in this team

Update a discount

PATCH /c/api/v1/discounts/{id}

Updates a discount definition. All fields are optional; omitted fields retain their current values. Requires discounts_write.

Path parameters

FIELD	TYPE	DESCRIPTION
`id`	string · required	Discount definition id.

Request body

FIELD	TYPE	DESCRIPTION
`discount`	object
`discount.name`	string
`discount.discount_type`	string one of `percentage`, `fixed`
`discount.rate`	string
`discount.amount`	string
`discount.description`	string
`discount.active`	boolean
`discount.position`	integer

Code samples

curl --request PATCH \
  --url 'https://api.cornerspot.net/c/api/v1/discounts/abc123' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --data '{
  "discount": {
    "name": "string",
    "discount_type": "percentage",
    "rate": "string",
    "amount": "string",
    "description": "string",
    "active": true,
    "position": 1
  }
}'

const response = await fetch('https://api.cornerspot.net/c/api/v1/discounts/abc123', {
  method: 'PATCH',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_API_KEY'
  },
  body: JSON.stringify({
    "discount": {
      "name": "string",
      "discount_type": "percentage",
      "rate": "string",
      "amount": "string",
      "description": "string",
      "active": true,
      "position": 1
    }
  })
});

const data = await response.json();
console.log(data);

// Node.js 18+ (native fetch)
const response = await fetch('https://api.cornerspot.net/c/api/v1/discounts/abc123', {
  method: 'PATCH',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_API_KEY'
  },
  body: JSON.stringify({
    "discount": {
      "name": "string",
      "discount_type": "percentage",
      "rate": "string",
      "amount": "string",
      "description": "string",
      "active": true,
      "position": 1
    }
  })
});

if (!response.ok) {
  throw new Error(`Request failed: ${response.status}`);
}

const data = await response.json();
console.log(data);

import json
import urllib.request

url = "https://api.cornerspot.net/c/api/v1/discounts/abc123"
payload = json.dumps({
  "discount": {
    "name": "string",
    "discount_type": "percentage",
    "rate": "string",
    "amount": "string",
    "description": "string",
    "active": true,
    "position": 1
  }
}).encode("utf-8")
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer YOUR_API_KEY",
}

request = urllib.request.Request(url, data=payload, headers=headers, method="PATCH")

with urllib.request.urlopen(request) as response:
    data = json.loads(response.read().decode("utf-8"))
    print(data)

require "json"
require "net/http"

uri = URI("https://api.cornerspot.net/c/api/v1/discounts/abc123")

request = Net::HTTP::Patch.new(uri)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer YOUR_API_KEY"
request.body = JSON.generate({
  "discount": {
    "name": "string",
    "discount_type": "percentage",
    "rate": "string",
    "amount": "string",
    "description": "string",
    "active": true,
    "position": 1
  }
})

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts JSON.parse(response.body)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.cornerspot.net/c/api/v1/discounts/abc123',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'PATCH',
    CURLOPT_HTTPHEADER => [
        'Content-Type: application/json',
        'Authorization: Bearer YOUR_API_KEY',
    ],
    CURLOPT_POSTFIELDS => json_encode([
    'discount' => [
        'name' => 'string',
        'discount_type' => 'percentage',
        'rate' => 'string',
        'amount' => 'string',
        'description' => 'string',
        'active' => true,
        'position' => 1,
    ],
]),
]);

$response = curl_exec($curl);
curl_close($curl);

$data = json_decode($response, true);
print_r($data);

Responses

STATUS	DESCRIPTION
`200` OK	updated
`401` Unauthorized	missing or invalid API key
`403` Forbidden	the key lacks the discounts_write scope
`404` Not Found	no such discount in this team
`422` Unprocessable Content	validation errors (e.g. blank name)

Delete a discount

DELETE /c/api/v1/discounts/{id}

Destroys a discount definition. Returns 204 on success. Returns 422 if the record has blocking dependants that prevent deletion (e.g. referenced by live invoice line items); the response body includes an errors array of human-readable blocker messages. Requires discounts_write.

Path parameters

FIELD	TYPE	DESCRIPTION
`id`	string · required	Discount definition id.

Query parameters

FIELD	TYPE	DESCRIPTION
`reason`	string	Optional human-readable reason for deletion, stored in the audit trail.

Code samples

curl --request DELETE \
  --url 'https://api.cornerspot.net/c/api/v1/discounts/abc123' \
  --header 'Authorization: Bearer YOUR_API_KEY'

const response = await fetch('https://api.cornerspot.net/c/api/v1/discounts/abc123', {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});

const data = await response.json();
console.log(data);

// Node.js 18+ (native fetch)
const response = await fetch('https://api.cornerspot.net/c/api/v1/discounts/abc123', {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});

if (!response.ok) {
  throw new Error(`Request failed: ${response.status}`);
}

const data = await response.json();
console.log(data);

import json
import urllib.request

url = "https://api.cornerspot.net/c/api/v1/discounts/abc123"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}

request = urllib.request.Request(url, headers=headers, method="DELETE")

with urllib.request.urlopen(request) as response:
    data = json.loads(response.read().decode("utf-8"))
    print(data)

require "json"
require "net/http"

uri = URI("https://api.cornerspot.net/c/api/v1/discounts/abc123")

request = Net::HTTP::Delete.new(uri)
request["Authorization"] = "Bearer YOUR_API_KEY"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts JSON.parse(response.body)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.cornerspot.net/c/api/v1/discounts/abc123',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_API_KEY',
    ],
]);

$response = curl_exec($curl);
curl_close($curl);

$data = json_decode($response, true);
print_r($data);

Responses

STATUS	DESCRIPTION
`204` No Content	deleted
`401` Unauthorized	missing or invalid API key
`403` Forbidden	the key lacks the discounts_write scope
`404` Not Found	no such discount in this team

List discounts

Query parameters

Code samples

Responses

Create a discount

Request body

Code samples

Responses

Get a discount

Path parameters

Code samples

Responses

Update a discount

Path parameters

Request body

Code samples

Responses

Delete a discount

Path parameters

Query parameters

Code samples

Responses

Was this article helpful?