Sign in
Entity Integration Mappings

Create entity integration mapping

Use when linking a FlexPrice entity to an external system (e.g. CRM or payment provider) so you can sync or reconcile by external ID.

post/entity-integration-mappings

Request body

entity_idstring required
entity_type'customer' | 'plan' | 'invoice' | 'subscription' | 'payment' | 'credit_note' | 'addon' | 'item' | 'item_price' | 'price' required
metadataobject
provider_entity_idstring required
provider_typestring required

Response

Created

created_atstring
created_bystring
entity_idstring
entity_type'customer' | 'plan' | 'invoice' | 'subscription' | 'payment' | 'credit_note' | 'addon' | 'item' | 'item_price' | 'price'
environment_idstring
idstring
provider_entity_idstring
provider_typestring
status'published' | 'deleted' | 'archived'
tenant_idstring
updated_atstring
updated_bystring

Changes