Create a subscription
Learn how to create a subscription on Yorlet.
Using Yorlet Leasing
When you create a tenancy application, a subscription is automatically created for each customer based of the tenancy information. The subscription generates invoices based on the billing interval you set during the application process.
Create a subscription manually
To create a subscription, follow these steps:
- Navigate to the customer you want to create a subscription for.
- Click on the Actions menu and select Create subscription.
- You can optionally associate the subscription with an active tenancy if the customer has one.
- Select the Currency you’d like to use.
- Set the schedule for the subscription, including the Billing interval, Start date, and End date.
- Use the Pricing table to add line items to the subscription.
- Configure the Collection method for the subscription.
- Click Create subscription.
Collection methods
Subscriptions in Yorlet can be created as one of two variations:
- Charge automatically: use a saved payment method such as Bacs Direct Debit to automatically charge your customer when the subscription is due.
- Send invoice: email your customer a link to a Hosted Invoice where they can pay manually.
Schedule
The schedule section allows you to configure the billing schedule for the subscription.
Billing frequency
The interval describes the frequency at which the subscription should be billed. It can be one of week, month, year or custom.
The interval count describes number of intervals (specified in the interval attribute) between subscription billings. For example, interval=month and interval_count=3 bills every 3 months.
In the Dashboard you can select from the following options:
- Weekly: bills the customer every week.
- Every 4 weeks: bills the customer every 4 weeks.
- Monthly: bills the customer every month.
- Every 3 months: bills the customer every 3 months.
- Every 6 months: bills the customer every 6 months.
- Custom: bills the customer at a custom interval.
Start and end dates
The Start date can be used to activate the subscription at a future date or back date a subscription. When supplying a start date in the future the subscription’s initial status will be scheduled.
The End date can be used to stop a subscription from creating any more invoices in the future. When a subscription ends due to the end date passing, the subscription’s status will change to complete. If you don’t specify an end date the subscription will bill the customer indefinitely or until it is cancelled.
Pricing table
The pricing table allows you to add line items to the subscription. Each line item can have a name, description, quantity, unit amount, and tax rate. You can also customise the transfer behaviour for each line item.
The items array describes each line item you’d like the subscription to bill the customer for. An item can have a type of rent or charge. We recommend using type=rent to charge for rent, when using type=rent you must also supply the unit the payment is for so Yorlet can provide robust reporting.
The items array describes each line item you’d like the subscription to bill the customer for. An item can have a type of rent or charge. We recommend using type=rent to charge for rent, when using type=rent you must also supply the unit the payment is for so Yorlet can provide robust reporting.
When the subscription’s interval is set to custom you can provide phases, which automate changes to a subscription over time.
Each phase has a start date that determines when the phase will begin, the start date of one phase can’t be before the previous phase. Each phase should also include line items to replace the previous phase.
For example, a student that you want to charge before their student finance becomes available.
- The first phase will begin on 15/01/2024 and include a rent item for £3,000.
- The second phase will replace the first on the 16/03/2024 and charge £2,500 for rent.
Once all phases have completed the subscription status will transition to complete.
Advanced options
We also support some advance options when creating a subscription.
Custom invoice fields
Custom invoice fields
Add custom fields to the invoice to add additional information to the generated PDF.
Transfer behaviour
The transfer behavior determines how the value of the line item is transferred to an owner, if at all. You can customise the transfer behaviour for each line item in the pricing table.
- Auto: transfers the value of the line item to the owner of the unit based on the unit’s ownership structure. The line item must have an associated unit.
- Owner: transfers the value of the line item to a specified owner.
- None: will not initate any transfers.