Skip to main content
POST
/
integrations
/
link
Link integration mapping
curl --request POST \
  --url https://us.api.flexprice.io/v1/integrations/link \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "entity_id": "<string>",
  "entity_type": "customer",
  "provider_entity_id": "<string>",
  "provider_type": "<string>",
  "metadata": {}
}
'
{
  "mapping": {
    "created_at": "2023-11-07T05:31:56Z",
    "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": "2023-11-07T05:31:56Z",
    "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

Link mapping request

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

Response

OK

mapping
object