Update Plan

put

https://{subdomain}.{domain}/v2/plans/{plan_code}

Update the pricing or details for a plan. Existing subscriptions will remain at the previous renewal amounts.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

plan_code

string

required

Unique code to identify the plan.

Body Params

plan_code

string

length ≤ 50

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

name

string

length ≤ 255

Plan name. Max of 255 characters.

unit_amount_in_cents

array of objects

length ≤ 10000000

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

unit_amount_in_cents

pricing_model

string

enum

Defaults to fixed

A fixed pricing model has the same price (i.e. unit_amount_in_cents)
for each billing period. A ramp pricing model instead defines a set of
ramp intervals (i.e. ramp_intervals), where a subscription changes
price on a specified cadence of billing periods. The price change could
be an increase or decrease. Ramp pricing is only available on Recurly
Pro and Elite plans, as well as sandbox sites.

Allowed:

description

string

Optional plan description, not displayed.

trial_interval_unit

string

Defaults to days

days or months, defaults to days.

trial_interval_length

integer

Defaults to 0

Defaults to 0, for no trial

trial_requires_billing_info

boolean

Allow free trial subscriptions to be created without billing info. Should not be used if billing info is needed for initial invoice due to existing uninvoiced charges or setup fee.

success_url

string

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

accounting_code

string

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

revenue_schedule_type

string

Defaults to evenly

Optional field for setting a revenue schedule type. This will determine how revenue for the associated Plan should be recognized. When creating a Plan, available schedule types are never, evenly, at_range_start, or at_range_end.

liability_gl_account_id

string

length ≤ 13

The ID of a general ledger account. General ledger accounts are
only accessible as a part of the Recurly RevRec Standard and
Recurly RevRec Advanced features.

revenue_gl_account_id

string

length ≤ 13

The ID of a general ledger account. General ledger accounts are
only accessible as a part of the Recurly RevRec Standard and
Recurly RevRec Advanced features.

performance_obligation_id

string

length ≤ 13

The ID of a performance obligation. Performance obligations are
only accessible as a part of the Recurly RevRec Standard and
Recurly RevRec Advanced features.

setup_fee_accounting_code

string

Accounting code for a Setup Fee, code may only contain the following characters: [a-z 0-9 @ - _ .]. Max of 20 characters.

setup_fee_revenue_schedule_type

string

Defaults to evenly

Optional field for setting a revenue schedule type. This will determine how revenue for the associated Plan Setup Fee should be recognized. When creating a Plan Setup Fee, available schedule types are never, evenly, at_range_start, or at_range_end.

setup_fee_liability_gl_account_id

string

length ≤ 13

The ID of a general ledger account. General ledger accounts are
only accessible as a part of the Recurly RevRec Standard and
Recurly RevRec Advanced features.

setup_fee_revenue_gl_account_id

string

length ≤ 13

The ID of a general ledger account. General ledger accounts are
only accessible as a part of the Recurly RevRec Standard and
Recurly RevRec Advanced features.

setup_fee_performance_obligation_id

string

length ≤ 13

The ID of a performance obligation. Performance obligations are
only accessible as a part of the Recurly RevRec Standard and
Recurly RevRec Advanced features.

setup_fee_in_cents

array of objects

length ≤ 10000000

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

setup_fee_in_cents

total_billing_cycles

integer

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

unit_name

string

Deprecated 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.

cancel_url

string

Deprecated 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.

auto_renew

boolean

Defaults to true

Determines whether subscriptions to this plan should auto-renew term at the end of the current term or expire.

bypass_hosted_confirmation

boolean

If true, the customer will be sent directly to your success_url after a successful signup, bypassing Recurly's hosted confirmation page.

allow_any_item_on_subscriptions

boolean

Defaults to false

Used to determine whether items can be assigned as add-ons to individual subscriptions. If true, items can be assigned as add-ons to individual subscription add-ons. If false, only plan add-ons can be used.

vertex_transaction_type

string

Defaults to sale

Used by Vertex for tax calculations. Possible values are sale, rental, lease.

dunning_campaign_id

string

Unique ID to identify a dunning campaign. Available when the Dunning Campaigns feature is enabled. Used to specify if a non-default dunning campaign should be assigned to this plan. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.

custom_fields

array of objects

The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.

Custom Fields

Response

200