POST
/
entity-integration-mappings
Create entity integration mapping
curl --request POST \
  --url https://api.cloud.flexprice.io/v1/entity-integration-mappings \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "entity_id": "<string>",
  "entity_type": "customer",
  "metadata": {},
  "provider_entity_id": "<string>",
  "provider_type": "<string>"
}'
{
  "created_at": "<string>",
  "created_by": "<string>",
  "entity_id": "<string>",
  "entity_type": "customer",
  "environment_id": "<string>",
  "id": "<string>",
  "provider_entity_id": "<string>",
  "provider_type": "<string>",
  "status": "published",
  "tenant_id": "<string>",
  "updated_at": "<string>",
  "updated_by": "<string>"
}

Authorizations

x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Body

application/json

Entity integration mapping data

entity_id
string
required
Maximum length: 255
entity_type
enum<string>
required
Available options:
customer,
plan,
invoice,
subscription,
payment,
credit_note
provider_entity_id
string
required
Maximum length: 255
provider_type
string
required
Maximum length: 50
metadata
object

Response

Created

created_at
string
created_by
string
entity_id
string
entity_type
enum<string>
Available options:
customer,
plan,
invoice,
subscription,
payment,
credit_note
environment_id
string
id
string
provider_entity_id
string
provider_type
string
status
enum<string>
Available options:
published,
deleted,
archived
tenant_id
string
updated_at
string
updated_by
string