Iron Plans
Search…
Custom Copy

Overview

While we welcome custom copy, please let us know if there are certain flows that you think have confusing copy. If it's confusing to you, it's probably confusing to other folks, so we might as well fix it for everyone!
You have the ability to customize copy in select places. Used sparingly, it's a good way to inject your brand's tone into Iron Plans. CustomCopy has a similar interface as Theme and can be passed into your widgets in a similar manner.
1
interface CustomCopy {
2
cardModal: {
3
selectFreePlanConfirmation: {
4
header: string
5
body: string
6
}
7
cancelConfirmation: {
8
header: string
9
body: string
10
}
11
switchPlanConfirmation: {
12
header: string
13
body: string
14
}
15
customPlanConfirmation: {
16
header: string
17
body: string
18
}
19
renewConfirmation: {
20
header: string
21
body: string
22
}
23
paymentConfirmation: {
24
header: string
25
}
26
}
27
}
Copied!
Pass in your custom copy like so:
1
const customCopy = {
2
cardModal: {
3
cancelConfirmation: { header: 'Are you really, REALLY sure you want to cancel?' },
4
switchPlanConfirmation: { header: "Whoa, you're about to switch to {{planName}}." },
5
},
6
}
7
8
<PlanSelect theme={theme} customCopy={customCopy} />
Copied!
Custom copy is relatively limited. We are not allowing custom copy for places such as CheckoutForm's body due to their dynamic nature with many different states and copy variations. PaymentConfirmation's body is a particular special case - you can customize it, but if a trial exists, the following text will get appended regardless of your custom text:
1
You will be charged <b>{paymentAmt}</b> automatically after your trial ends in {trialDays} days.
Copied!

Params

In dialogs where a plan name is specified, you'll also be able to reference it as well using mustache style template variables.
1
{{planName}}
Copied!
Copy link