API v1: Subscription Plans

Just as accounts are uniquely identified by an account code, subscription plans are identified by a unique plan code.

The pricing and interval times are versioned for subscription plans. When the pricing or duration is altered, existing subscribers will retain their current subscription plans by default.

Subscription plans can be modified through the web interface. The API exposes subscription plan information for read-only purposes.

Plan Attributes

plan_code

Your unique reference code for the Subscription Plan

name

Plan name

description

Your description of the subscription plan. Not displayed to end users

success_url

The URL to redirect to after a successful subscription signup

cancel_url

The URL to redirect to if the user aborts the signup process

created_at

Date the credit was created

unit_amount_in_cents

The default price per unit for the plan in cents. Divide by 100 to convert to dollars.

setup_fee_in_cents

The default setup fee for the plan in cents. Divide by 100 to convert to dollars.

plan_interval_length

Amount of time (in days or months) before the subscriber is charged again.

plan_interval_unit

Indicates whether the plan interval length is specified as 'days' or 'months'

trial_interval_length

Trial length. Zero (0) indicates there is no trial -- the subscription begins immediately

trial_interval_unit

Indicates whether the trial interval length is specified as 'days' or 'months'

List Plans

Lists all your active subscription plans.

Code examples

PHP

1

$plan = RecurlyPlan::getPlans();

Ruby

1

plans = Recurly::Plan.find(:all)

Python

1

plan = recurly.company.plans()

Get Subscription Plan Details

Return the specifics for a given subscription plan.

Code examples

PHP

1

$plan = RecurlyPlan::getPlan(PLAN_CODE);

C#

1

RecurlyPlan plan = RecurlyPlan.Get(planCode);

Create a Plan

Please use API v2.

Update a Plan

Please use API v2.

Delete a Plan

Please use API v2.