Skip to main content
GET
/
discounts
/
{discount_id}
Get a discount
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.paddle.com/discounts/{discount_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "data": {
    "id": "dsc_01hv6scyf7qdnzcdq01t2y8dx4",
    "status": "active",
    "description": "Seasonal sale",
    "enabled_for_checkout": true,
    "code": "SPRINGSALE",
    "type": "percentage",
    "mode": "standard",
    "amount": "10",
    "currency_code": null,
    "recur": true,
    "maximum_recurring_intervals": 3,
    "usage_limit": null,
    "restrict_to": [
      "pro_01gsz4t5hdjse780zja8vvr7jg",
      "pro_01gsz4s0w61y0pp88528f1wvvb"
    ],
    "expires_at": "2024-12-03T00:00:00Z",
    "times_used": 0,
    "custom_data": null,
    "import_meta": null,
    "created_at": "2024-04-11T14:36:14.695Z",
    "updated_at": "2024-04-11T14:41:22.343Z"
  },
  "meta": {
    "request_id": "74d0b3ed-9eba-437e-bbcc-f5619bb5a661"
  }
}

Authorizations

Authorization
string
header
required

Requests are authenticated with API keys. Provide your API key as a Bearer token in the Authorization header.

API keys are assigned permissions, granting them access to entities and operations. Each endpoint may require one or more permissions, defined with the x-permissions extension. Values for include parameters may require specific permissions as defined in the x-enum-permissions extension. See all available permissions in the permission schema or documentation.

Get an API key and select the permissions you need from the Paddle dashboard under Paddle > Developer Tools > Authentication.

Path Parameters

discount_id
string
required

Paddle ID of the discount entity to work with.

Example:

"dsc_01gt218xfk7yztpvgmcazkes83"

Response

OK

data
Discount · object
required

Represents a discount entity.

meta
Meta · object
required

Information about this response.