PApaddlehq
Products

Get a product

Changed on

Returns a product using its ID.

Use the include parameter to include related price entities in the response.

get/products/{product_id}

Request

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

Path parameters

product_idstring required

Paddle ID of the product entity to work with.

Query parameters

includeProductIncludeEnum[]

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

Response

The request has succeeded.

Example response

{
  "data": {
    "id": "pro_01gsz97mq9pa4fkyy0wqenepkz",
    "custom_data": {
      "customer_reference_id": "abcd1234"
    },
    "import_meta": {
      "external_id": "9b95b0b8-e10f-441a-862e-1936a6d818ab",
      "imported_from": "paddle_classic"
    },
    "created_at": "2024-10-12T07:20:50.52Z",
    "updated_at": "2024-10-13T07:20:50.52Z",
    "prices": [
      {
        "id": "pri_01gsz8z1q1n00f12qt82y31smh",
        "product_id": "pro_01gsz97mq9pa4fkyy0wqenepkz",
        "quantity": {
          "minimum": 1,
          "maximum": 100
        },
        "custom_data": {
          "customer_reference_id": "abcd1234"
        },
        "import_meta": {
          "external_id": "9b95b0b8-e10f-441a-862e-1936a6d818ab",
          "imported_from": "paddle_classic"
        },
        "created_at": "2024-10-12T07:20:50.52Z",
        "updated_at": "2024-10-13T07:20:50.52Z"
      }
    ]
  },
  "meta": {
    "request_id": "b15ec92e-8688-40d4-a04d-f44cbec93355"
  }
}

Changes

  • v14f35a8c6ea4dRevision changes
    • breaking

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

    • breaking

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

  • v1e1ac347eb3c5Revision changes
    • warning

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

    • 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

    • warning

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

    • info

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

    • info

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