Discounts

Returns a paginated list of discounts. Use the query parameters to page through results.

By default, Paddle returns discounts that are active. Use the status query parameter to return discounts that are archived.

get/discounts

Request

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

Query parameters

idstring[]

Return only the IDs specified. Use a comma-separated list to get multiple entities.

afterstring

Return entities after the specified Paddle ID when working with paginated endpoints. Used in the meta.pagination.next URL in responses for list operations.

per_pageinteger

Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is requested. Check meta.pagination.per_page in the response to see how many were returned.

Default: 50; Maximum: 200.

includeDiscountIncludeEnum[]

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

codestring[]

Return entities that match the discount code. Use a comma-separated list to specify multiple discount codes.

order_bystring

Order returned entities by the specified field and direction ([ASC] or [DESC]). For example, ?order_by=id[ASC].

Valid fields for ordering: created_at and id.

statusDiscountStatusQueryEnum[]

Return entities that match the specified status. Use a comma-separated list to specify multiple status values.

mode'standard' | 'custom'

Return entities that match the specified mode.

discount_group_idstring[]

Return entities related to the specified discount group. Use a comma-separated list to specify multiple discount group IDs.

Headers

Skip-Countstring

Set to true to skip the count query on list operations. When set, meta.pagination.estimated_total returns -1 instead of an exact count.

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",
    "pagination": {
      "estimated_total": 999
    }
  }
}

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

    • info

      added the new optional header request parameter Skip-Count

    • breaking

      for the query request parameter status, default value active was added

    • breaking

      response property data/items/maximum_recurring_intervals list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property data/items/restrict_to list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property data/items/usage_limit list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      the // response's property type changed from string to no type, and format from date-time to no format for status

    • breaking

      the // response's property type changed from string to no type for status

    • breaking

      the // response's property type changed from string to no type for status

    • breaking

      the // response's property type changed from string to no type for status

    • breaking

      the // response's property type changed from string to no type, and format from date-time to no format for status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added the new optional query request parameter discount_group_id

    • info

      added the new optional query request parameter include

    • info

      added the optional property // to the response with the status

    • info

      the response optional property // became not read-only for the status

    • info

      added to the response property allOf list for the response status

    • info

      added to the // response property allOf list for the response status

    • info

      added to the // response property allOf list for the response status

    • info

      added to the // response property allOf list for the response status

    • info

      added to the // response property allOf list for the response status

    • info

      added to the // response property allOf list for the response status

    • info

      added subschema #2 to the // response property anyOf list for the response status

    • info

      added subschema #2 to the // response property anyOf list for the response status

    • info

      added subschema #2 to the // response property anyOf list for the response status

    • info

      added subschema #2 to the // response property anyOf list for the response status

    • info

      added subschema #2 to the // response property anyOf list for the response status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      removed the active enum value from the // response property for the response status

    • info

      removed the archived enum value from the // response property for the response status

    • info

      removed the custom enum value from the // response property for the response status

    • info

      removed the standard enum value from the // response property for the response status

    • info

      removed subschema #2 from the // response property oneOf list for the response status

    • info

      removed subschema #2 from the // response property oneOf list for the response status

    • info

      removed subschema #2 from the // response property oneOf list for the response status

    • info

      removed subschema #2 from the // response property oneOf list for the response status

    • info

      removed subschema #2 from the // response property oneOf list for the response status

    • info

      the // response's property pattern ^dsc_[a-z\d]{26}$ was removed for the status

    • info

      added the required property // to the response with the status