Pricing Page Configs

Search…

Pricing Page Configuration Options

Available Configs
email
Type
Required
Description
String
No
The customer's email address. Pass this in so customers do not need to enter in their email on signup.
{
    email: "[email protected]"
}
service
Type
Required
Description
String
No
The Billflow service. Use this to dynamically pass in different service to the billing page. 
{
    service: "Your Service"
}
customer_id
Type
Required
Description
String
No
The customer's Stripe Customer ID. Pass this in to checkout an existing customer. You must have already created the Stripe Customer object to use this.
{
        customer_id: "cus_FtWXI6U0YxebLd"
}
handleResponse
Type
Required
Description
Function
No
Function that is called when users signup, change plan (upgrade/downgrade), resubscribe, or update Credit Card. Used to update user data, do redirects, or provide notifications. Payload contains an event name and a response object. Learn More.
{
    handleResponse: async function(payload) {
      console.log("Event ", payload.event);
      console.log("Response Object ", payload.response);
    }
}
options.disableTiers
Type
Required
Description
Array
No
Use to dynamically disable certain tiers for a customer when selecting a plan. Add an array of tiers (corresponds to metadata tag sb_tier) to disable users from being able to change to those specific plans.
Eg: ['Tier 1', 'Tier 2']
{
  options: {
      disableTiers: ['Tier 1', 'Tier 2']
  }
}
options.quantity
Type
Required
Description
Object
No
Use to set the quantity of a subscription during creation. Can pass in an integer or an object of key-value pairs. The unit_label is defined on the Stripe product and used to define which quantity is being set. If an integer is passed, it will apply the quantity to all products on the tier, if an object is passed with the unit_labels as keys, it will assign that quantity to the respective unit_label.
Eg: 5
OR
Eg: {product_unit_label1 : 10, unit_label2: 20}
{
  options: {
      quantity: {
        super_user: 3,
        user: 5,
      },
  }
}

Customer Portal Configs

Invoice Portal Configs

Last modified 1yr ago

Copy link

On this page

Available Configs

service

customer_id

handleResponse

options.disableTiers

options.quantity