Link customer integration
Links a customer to an external integration by specifying the vendor and external entity ID.
Authorizations
Server API Key
Headers
Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.
Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).
Path Parameters
The unique identifier of the entity
1 - 255Body
Links a customer to an integration, specifying which external entity (e.g. Stripe customer ID) the customer maps to. syncedEntityId is required on creation, though the same field can read back as null on other integration links that have not yet synced.
The internal ID of the integration this record is linked to
255The vendor identifier of the integration (e.g. STRIPE, SALESFORCE, SNOWFLAKE)
AUTH0, ZUORA, STRIPE, HUBSPOT, AWS_MARKETPLACE, SNOWFLAKE, SALESFORCE, BIG_QUERY, OPEN_FGA, APP_STORE, RECEIVED, PREQUEL, AIRWALLEX, STRIPE_INVOICING The external entity ID this record is linked to in the vendor system (e.g. the Stripe customer ID). Null until the link has synced; required when creating the link.
255Response
The created customer integration object.
Response object
Links this customer to their record in a specific configured integration (e.g. their Stripe customer ID under your Stripe integration). A customer has at most one link per integration.
Related topics
Unlink customer integrationUpdate a customer integrationAllow customers to subscribe to my product using a payment linkGet a list of customer integrationsGet a single customer integration by ID