HPP URL Parameters Explained

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

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

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

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

--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

Subscription Custom Fields and Additional Data

SubscriptionFlow allows you to pass values to Subscription Custom Fields and Additional Data through URL parameters.

Subscription Custom Fields:

SubscriptionFlow automatically generates a unique field name with the scf_ prefix for custom fields. To pass a value for a Subscription Custom Field, add the cf_ prefix before the generated field name:

{{hpp_link}}?cf_{{field_name}}={{value}}

Example:

If the custom field name generated by SubscriptionFlow is scf_utm_content, use:

{{hpp_link}}?cf_scf_utm_content=paid

You can pass multiple Subscription Custom Fields in the same URL:

{{hpp_link}}?cf_scf_utm_content=paid&cf_scf_utm_content_1=facebook&cf_scf_utm_content_2=120247252701500519

Subscription Additional Data:

To pass Subscription Additional Data, use the sc_additional_data_ prefix followed by the field name and value:

{{hpp_link}}?sc_additional_data_{{field_name}}={{value}}

Example:

{{hpp_link}}?sc_additional_data_utm_source=google

Note: For Subscription Custom Fields, use the scf_ field name generated by SubscriptionFlow and add the cf_ prefix when passing it through the URL.