This article enlists all the URL parameters that can be added to the URL of Hosted Payment Pages and used to pre-populate the data fields.
Account Information Section
# | Title | Parameters |
1. | First Name | ai_firstName |
2. | Last Name | ai_lastName |
3. | ai_email | |
4. | Phone | ai_phone |
5. | Notes | ai_notes |
Example URL:
https://[[your-custom-domain]].subscriptionflow.com/en/hosted-page/subscribe/[[your-product-id]]/product/[[your-plan-id]]?ai_firstName=John&ai_lastName=Doe&ai_email=test@mailinator.com&ai_phone=%2B1-202-555-0145&ai_notes=Pickup
*Note: %2B is used before the phone number to replace "+" and auto-select the country code from the dropdown.
Billing Address Section
# | Title | Parameter |
1. | Country | ai_billing_country |
2. | Address Line 1 | ai_billing_address1 |
3. | Address Line 2 | ai_billing_address2 |
4. | State | ai_billing_state |
5. | City | ai_billing_city |
6. | Zip | ai_billing_zip |
Example URL:
https://[[your-custom-domain]].subscriptionflow.com/en/hosted-page/subscribe/[[your-product-id]]/product/[[your-plan-id]]?ai_billing_country=US&ai_billing_address1=House%20Number%20%23%2010&ai_billing_address2=New%20Road%2C%20Next%20to%20train%20station&ai_billing_state=NewYork&ai_billing_city=New%20York&ai_billing_zip=12345
Shipping Address Section
# | Title | Parameter |
1. | Country | ai_shipping_country |
2. | Address Line 1 | ai_shipping_address1 |
3. | Address Line 2 | ai_shipping_address2 |
4. | State | ai_shipping_state |
5. | City | ai_shipping_city |
6. | Zip | ai_shipping_zip |
Example URL:
https://[[your-custom-domain]].subscriptionflow.com/en/hosted-page/subscribe/[[your-product-id]]/product/[[your-plan-id]]?ai_shipping_country=US&ai_shipping_address1=House%20Number%20%23%2010&ai_shipping_address2=New%20Road%2C%20Next%20to%20train%20station&ai_shipping_state=NewYork&ai_shipping_city=New%20York&ai_shipping_zip=12345
Order summary Section
# | Title | Parameter |
1. | Coupon | coupon_code |
2. | Assigned to | assigned_to |
3. | Created by | created_by |
4. | Currency | currency |
5. | Additional Plans | additional_plans |
6. | Auto check Policy | auto_check_policy |
7. | Hide currency | hide_currency |
8. | Payment Widget | payment_widget |
9. | Base Product Quantity | charge_quantity |
--we'll be adding examples of the order summary parameters soon--
addtional plans example:
https://[your subdomain].subscriptionflow.com/en/hosted-page/subscribe/48331532632381/product/9252506501437?additional_plans[9491485753661][][pl]=48924176154941
Custom URL Parameters
SubscriptionFlow also allows you to add any custom fields and then use them as custom URL parameters.
For this purpose, you can follow these steps:
1. From the top navigation bar, please click on the gear icon and navigate to the Admin settings. Here under the customizations section, you will find Studio. Click to open it.
2. Open the Customers module
3. Add a custom field by selecting from the left pane and drag-drop it to the form area.
4. Next click on Edit and rename the field by clicking Edit attributes.
5. Once the field is renamed, click on edit again and copy the technical name of the field. This is the field key which you will need later at step 10 .
6. Click save changes from the top right.
7. Next, go back to the dashboard and navigate to Paymentsflow.
8. Click open the dropdown under Web Checkout and click to open Designer.
9. Next, go to the Account Information tab, scroll down and enable the custom field you have just added.
Now you are all set to use this custom field in the URL parameters.
10. To generate the parameter, you can follow :
{{hpp_link}}?ai_custom_fields_{{field_key}={{value}}
For example:
https://example.subscriptionflow.com/en/hosted-page/subscribe/43959911907558/product/8307324715238?ai_custom_fields_scf_custom_5v1=hello
Comments
0 comments
Please sign in to leave a comment.