PUT
/
plans
/
{plan_id}
/
options
/
{option_id}
curl --request PUT \
  --url https://api.live.paisr.tech/{version}/plans/{plan_id}/options/{option_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "<string>",
  "unit_price": 1.01,
  "billing_interval": 183,
  "trial_period": 182.5,
  "attributes": {}
}'
{
  "success": true,
  "message": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

plan_id
string
required

The Plan ID.

option_id
string
required

The Option ID.

Body

application/json
The details required to update a plan option.
description
string

Detailed description about the option.

unit_price
number

Price per unit.

Required range: x >= 0.01
billing_interval
number

The number of days for each billing interval. (e.g. 30 for monthly or 365 for yearly)

Required range: 1 <= x <= 365
trial_period
number

The number of days before the first billable invoice is due.

Required range: 0 <= x <= 365
attributes
object

Custom key-value pairs that can be used for option specific features.

Response

200
application/json
Successfully updated plan option.
success
boolean

Indicates if the request was successful.

message
string

A descriptive message regarding the result.