Paddle.Coupon.update

You're seeing just the function update, go back to Paddle.Coupon module for more information.
Link to this function

update(params, opts \\ [])

View Source

Specs

update(params, keyword()) :: {:ok, map()} | {:error, Paddle.Error.t()}
when params: %{
       optional(:coupon_code) => String.t(),
       optional(:group) => String.t(),
       optional(:new_coupon_code) => String.t(),
       optional(:new_group) => String.t(),
       optional(:product_ids) => String.t(),
       optional(:expires) => String.t(),
       optional(:allowed_uses) => integer(),
       optional(:currency) => String.t(),
       optional(:discount_amount) => number(),
       optional(:recurring) => boolean()
     }

Update an existing coupon in your account

There are 2 main ways to select which coupon(s) you want to update:

  • Updating a single coupon code? Specify coupon_code.
  • Updating a group of coupons? Specify their unique group name.

Examples

params = %{
  coupon_code: "TEST",
  discount_amount: 20
}
Paddle.Coupon.update(params)
{:ok, 1}