Create Plan

post

https://{subdomain}.recurly.com/v2/plans

Create a new subscription plan.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

plan_code

string

Unique code to identify the plan. This code may only contain the following characters: [a-z 0-9 @ - _ .]. Max of 50 characters.

name

string

Plan name. Max of 255 characters.

description

string

Optional plan description, not displayed

accounting_code

string

Accounting code for related invoice line items, defaults to ths code may only contain the following characters: [a-z 0-9 @ - _ .]. Max of 20 characters.

plan_interval_unit

string

"days", or "months", defaults to "months"

plan_interval_length

integer

Defaults to 1

Plan interval length, defaults to 1

trial_interval_unit

string

Defaults to months

days", or "months", defaults to "months"

trial_interval_length

integer

Defaults to 0

Defaults to zero, or no trial

setup_fee_in_cents

array

Array of currency objects, see examples. Max 10000000.

setup_fee_in_cents

unit_amount_in_cents

integer

Array of currency objects, see example below. Max 10000000.

total_billing_cycles

string

Defaults to null

Number of billing cycles before the plan stops renewing, defaults to null for continuous auto renewal.

unit_name

string

Unit description for the quantity, e.g. "users".

display_quantity

boolean

Defaults to false

Display the quantity field on the hosted payment page if true, defaults to false.

success_url

string

URL to redirect to after signup on the hosted payment pages.

cancel_url

string

URL to redirect to on canceled signup on the hosted payment pages.

tax_exempt

boolean

true exempts tax on the plan, false applies tax on the plan. If not defined, then defaults to the Plan and Site settings.

tax_code

string

length ≤ 50

Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine taxation rules. You can pass in specific tax codes using any of these tax integrations. For Recurly's In-the-Box tax offering you can also choose to instead use simple values of unknown, physical, or digital tax codes.

Response

201