PApaddlehq
Prices

List prices

Changed on

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

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

Use the include parameter to include the related product entity in the response.

get/prices

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.

includePriceListIncludeEnum[]

Include related entities in the response.

order_bystring

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

Valid fields for ordering: billing_cycle.frequency, billing_cycle.interval, id, product_id, quantity.maximum, quantity.minimum, status, tax_mode, unit_price.amount, and unit_price.currency_code.

product_idstring[]

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

statusStatusQuery[]

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

recurringboolean

Determine whether returned entities are for recurring prices (true) or one-time prices (false).

billing_cycle.interval'day' | 'week' | 'month' | 'year'

Return entities where the price billing cycle interval matches this value.

billing_cycle.frequencyinteger

Return entities where the price billing cycle frequency matches this value.

type'custom' | 'standard'

Type of item. Standard items are considered part of your catalog and are shown in the Paddle dashboard.

Return items that match the specified type.

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": "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",
      "product": {
        "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"
      }
    }
  ],
  "meta": {
    "request_id": "b15ec92e-8688-40d4-a04d-f44cbec93355",
    "pagination": {
      "estimated_total": 999
    }
  }
}

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 new optional header request parameter Skip-Count

    • info

      added the new optional query request parameter billing_cycle.frequency

    • info

      added the new optional query request parameter billing_cycle.interval

    • info

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

    • info

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