PApaddlehq
Discounts

Get a discount

Changed on

Returns a discount using its ID.

get/discounts/{discount_id}

Request

  • Base URL
    https://sandbox-api.paddle.com
  • Auth
    HTTP bearer

Path parameters

discount_idstring required

Paddle ID of the discount entity to work with.

Query parameters

includeDiscountIncludeEnum[]

Include related entities in the response. Use a comma-separated list to specify multiple entities.

Response

The request has succeeded.

Example response

{
  "data": {
    "id": "dsc_01gv5kpg05xp104ek2fmgjwttf",
    "expires_at": "2024-10-12T07:20:50.52Z",
    "custom_data": {
      "customer_reference_id": "abcd1234"
    },
    "discount_group_id": "dsg_01js2gqehzccfkywgx1jk2mtsp",
    "created_at": "2024-10-12T07:20:50.52Z",
    "updated_at": "2024-10-13T07:20:50.52Z",
    "import_meta": {
      "external_id": "9b95b0b8-e10f-441a-862e-1936a6d818ab",
      "imported_from": "paddle_classic"
    },
    "discount_group": {
      "id": "dsg_01js2gqehzccfkywgx1jk2mtsp",
      "created_at": "2024-10-12T07:20:50.52Z",
      "updated_at": "2024-10-13T07:20:50.52Z",
      "import_meta": {
        "external_id": "9b95b0b8-e10f-441a-862e-1936a6d818ab",
        "imported_from": "paddle_classic"
      }
    }
  },
  "meta": {
    "request_id": "b15ec92e-8688-40d4-a04d-f44cbec93355"
  }
}

Changes

  • v1bbc0c72039c8Revision changes
    • warning

      changed the pattern of the path request parameter discount_id from ^dsc_[a-z\d]{26}(?:@dscrev_[a-z\d]{26})?$ to ^dsc_[a-z\d]{26}$

  • v1e1ac347eb3c5Revision changes
    • warning

      added the new CLP enum value to the // response property for the response status

    • warning

      added the new PEN enum value to the // response property for the response status