Paddle.Modifier.create

You're seeing just the function create, go back to Paddle.Modifier module for more information.

Specs

create(params) :: {:ok, map()} | {:error, Paddle.Error.t()}
when params: %{
       subscription_id: integer(),
       modifier_recurring: boolean(),
       modifier_amount: number(),
       modifier_description: String.t()
     }

Create a subscription modifier to dynamically change the subscription payment amount

A modifier applied to a recurring subscription increases or decreases the next payment by a flat amount (in the currency of the subscription). The modifier itself may recur and apply to all future payments until it is removed.

Examples

Paddle.Modifier.create(params) 
params = %{
  subscription_id: 12345,
  modifier_recurring: true,
  modifier_amount: 20,
  modifier_description: "TestModifier"
}
{:ok, %{
  subscription_id: 12345,
  modifier_id: 10
}}