PApaddlehq
Prices

Create a price

Changed on

Creates a new price.

Prices describe how you charge for products. You must include a product_id in your request to relate this price to a product.

If you omit the quantity object, Paddle automatically sets a minimum of 1 and a maximum of 100 for you. This means the most units that a customer can buy is 100. Set a quantity if you'd like to offer a different amount.

If successful, your response includes a copy of the new price entity.

post/prices

Request

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

Request body

idstring

Unique Paddle ID for this price, prefixed with pri_.

descriptionstring required

Internal description for this price, not shown to customers. Typically notes for your team.

type'custom' | 'standard'

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

namestring

Name of this price, shown to customers at checkout and on invoices. Typically describes how often the related product bills.

product_idstring required

Unique Paddle ID for this product, prefixed with pro_.

tax_mode'account_setting' | 'external' | 'internal' | 'location'

How tax is calculated for this price.

custom_dataCustomData

Your own structured key-value data.

Example request

{
  "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"
  }
}

Response

The request has succeeded and a new resource has been created as a result.

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"
  },
  "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

    • info

      added to the ///// request property oneOf list

    • info

      added to the /// request property oneOf list

  • 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 request property //

    • info

      added the new optional request property //

    • info

      added the new CLP enum value to the request property //

    • info

      added the new CLP enum value to the request property ////

    • info

      added the new PEN enum value to the request property //

    • info

      added the new PEN enum value to the request property ////

    • info

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

    • info

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