Skip to main content
SubscriptionFlow Docs
API

HPP URL Parameters Explained

Updated

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. Email 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. Click the ⚙️ icon at the top right to open Settings. Under Customization, click Customization Studio.

  1. Open the Customers module

  1. Add a custom field by selecting from the left pane and drag-drop it to the form area.

  1. Next click on Edit and rename the field by clicking Edit attributes.

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

  1. Click save changes from the top right.

  1. Next, go to Settings and click Web Checkout Settings under Customization.

  1. Open the Designer tab.

  1. Click Account Information, 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.

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

Was this article helpful?1 out of 1 found this helpful
Have more questions? Submit a request

Comments

0 comments

Please sign in to leave a comment.