Convert a customer

Converts a click on a website to a customer, complete with all website visitor information and partner attribution.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Unique Click ID (if it's not unique, that's ok PS will accept it)

string
required

A unique identifier for the customer, this is the ID you will use to reference the customer in our API

string

Optional. Due to privacy concerns you may want to supply anonymized values here

string

Optional, though you may supply a non-unique value that is the same for each customer (e.g. "ACME Customer")

string

If using Stripe, Chargebee, Recurly, Chargify webhook integration and the customer record is created in the payment platform before the customer is created in PartnerStack, you can pass the customer ID from the payment processor in the provider_key field

string

The origin of the signup

string

An IP address is a unique address that identifies a device on the internet or a local network of the customer

string

The User-Agent request header is a string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent

string

External type takes any value that is being passed

sub_ids
array of strings

A SubID is a string of alphanumeric characters generated at the end of a redirect URL, which records a user-defined variable

sub_ids
meta
object

Additional fields to be set on the customer (Note: Must match the api_name of your custom customer fields)

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json