Update a Paddle Price — paddle_update

Updates an existing price entity in Paddle using its ID.

paddle_update_price(
  id,
  description = NULL,
  type = NULL,
  name = NULL,
  billing_cycle = NULL,
  trial_period = NULL,
  tax_mode = NULL,
  unit_price = NULL,
  unit_price_overrides = NULL,
  quantity = NULL,
  status = NULL,
  custom_data = NULL
)

Arguments

id: ID of the price. Required.
description: Internal description for your team. Required.
type: Type of item (one of `"standard"` and `"custom"`). Optional. Defaults to `"standard"`.
name: Name of this price (shown at checkout/invoices). Optional.
billing_cycle: List with `frequency` and `interval` (one of `"day"`, `"week"`, `"month"`, `"year"`). Optional. Omit for one-time pricing.
trial_period: List with `frequency` and `interval` (one of `"day"`, `"week"`, `"month"`, `"year"`). Optional. Requires `billing_cycle`.
tax_mode: One of `"account_setting"`, `"external"`, `"internal"`. Optional.
unit_price: A list with `amount` (string, lowest denomination, e.g. for 10 USD write 1000 (lowest denomination = cents)) and `currency_code` (3-letter ISO). Required.
unit_price_overrides: A list of overrides with `country_codes` (Supported two-letter ISO 3166-1 alpha-2 country code) and `unit_price` (same list as in unit_price parameter). Optional.
quantity: List with `minimum` and `maximum` quantity limits. Optional.
status: Status of the price (one of `"active"`, `"archived"`). Optional.
custom_data: Named list of custom metadata. Optional.

Value

A list representing the updated price entity.

Examples

if (FALSE) { # paddle_has_token()
set_paddle_mode("sandbox")
result <- paddle_update_price(
  id = "pri_123",
  name = "Updated Price Name"
)
}