Discounts

Get discount

Returns the discount for the given discount ID. Requires OAuth website scope website.discounts.read or website.discounts, or API key scope DISCOUNTS_READONLY or DISCOUNTS.

get/v1/commerce/discounts/{discountId}

Request

Base URL
https://api.squarespace.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/squarespace/apis/commerce-api/docs/v1/commerce/discounts/:discountId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

discountIdstring required

The discount's ID

Headers

Authorizationstring required

API key or OAuth access token

User-Agentstring required

User Agent

Response

Discount found.

Example response

{
  "discount": {
    "criteria": {
      "minimumCartTotal": {
        "value": 49.99
      }
    },
    "template": {
      "discountAmount": {
        "value": 49.99
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.