Order Information
User History
Prices
Coupons
Products
Licenses
Pay Links
Transactions
Subscription Users
Modifiers
Payments
One-off Charges
Webhooks
post

/2.0/subscription/plans_create

Create a new subscription billing plan with the supplied parameters.

Example request:

curl -X POST \
     -d 'vendor_id=123' \
     -d 'vendor_auth_code=14a5df6abc' \
     -d 'plan_name=My Subscription Plan' \
     -d 'plan_trial_days=0' \
     -d 'plan_type=month' \
     -d 'plan_length=1' \
     -d 'main_currency_code=USD' \
     -d 'initial_price_usd=0.00' \
     -d 'recurring_price_usd=5.00' \
     https://vendors.paddle.com/api/2.0/subscription/plans_create

Request Body

Form data (application/x-www-form-urlencoded)
vendor_id
integer

The vendor ID identifies your seller account. This can be found in Developer Tools > Authentication.

required
minimum: 1
pattern: \d+
vendor_auth_code
string

The vendor auth code is a private API key for authenticating API requests. This key should never be used in client side code or shared publicly. This can be found in Developer Tools > Authentication.

required
pattern: [0-9a-f]+
plan_name
string

The name of the subscription plan.

required
plan_trial_days
integer

The length of the trial period in days.

required
pattern: ^\d+$
minimum: 0
plan_type
string
required
Allowed Values: day, week, month, year
plan_length
integer
required
minimum: 1
pattern: ^\d+$
main_currency_code
string

Please note that the currency chosen will affect how the recurring_price_ parameter is set. So if the main_currency_code is set to GBP, the recurring_price parameter has to include recurring_price_gbp.

Allowed Values: USD, GBP, EUR
default: USD
pattern: [A-Z]{3}
intial_price_usd
number

The USD price of the first payment amount, or trial period payment.

intial_price_gbp
string

The GBP price of the first payment amount, or trial period payment.

intial_price_eur
string

The EUR price of the first payment amount, or trial period payment.

recurring_price_usd
string

The USD price that will be charged after the first payment.

recurring_price_gbp
string

The GBP price that will be charged after the first payment.

recurring_price_eur
string

The EUR price that will be charged after the first payment.

Responses

1 Example
Schema
object
or
object

An unsuccessful call to the Dashboard API will return a 200 response containing a field success set to false and an error object.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
No $$.env variables are being used in this request.