Global API
Request

Customer Portal Session URL

1min

The Customer Portal Session URL API allows you to create a link for a customer where they can add their Payment Methods. The link will take them to your processor-hosted Customer Portal.

The Customer Portal layout and configuration can only be set up in the payment processor. Check their official guide: Stripe.

When creating a Customer Portal URL, use the reqObj in the request to pass in the Customer and Payment Processor data. The returned response is in a JSON format that contains the URL to be shared with the customer.

Currently, the Customer Portal Session URL is supported by Stripe only.

Updated 11 Dec 2023
Doc contributor
Doc contributor
Doc contributor
Did this page help you?