Link integration mapping

Link a FlexPrice entity to provider entity with provider-specific side effects.

POST /integrations/link

Link integration mapping

cURL

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>",
  "provider_entity_id": "<string>",
  "provider_type": "<string>",
  "metadata": {}
}
'

import requests

url = "https://us.api.flexprice.io/v1/integrations/link"

payload = {
    "entity_id": "<string>",
    "provider_entity_id": "<string>",
    "provider_type": "<string>",
    "metadata": {}
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    entity_id: '<string>',
    provider_entity_id: '<string>',
    provider_type: '<string>',
    metadata: {}
  })
};

fetch('https://us.api.flexprice.io/v1/integrations/link', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://us.api.flexprice.io/v1/integrations/link",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'entity_id' => '<string>',
    'provider_entity_id' => '<string>',
    'provider_type' => '<string>',
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://us.api.flexprice.io/v1/integrations/link"

	payload := strings.NewReader("{\n  \"entity_id\": \"<string>\",\n  \"provider_entity_id\": \"<string>\",\n  \"provider_type\": \"<string>\",\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://us.api.flexprice.io/v1/integrations/link")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"entity_id\": \"<string>\",\n  \"provider_entity_id\": \"<string>\",\n  \"provider_type\": \"<string>\",\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://us.api.flexprice.io/v1/integrations/link")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"entity_id\": \"<string>\",\n  \"provider_entity_id\": \"<string>\",\n  \"provider_type\": \"<string>\",\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body

200

{
  "mapping": {
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "entity_id": "<string>",
    "environment_id": "<string>",
    "id": "<string>",
    "metadata": {},
    "provider_entity_id": "<string>",
    "provider_type": "<string>",
    "tenant_id": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "updated_by": "<string>"
  }
}

{
  "http_status_code": 123,
  "message": "<string>"
}

{
  "http_status_code": 123,
  "message": "<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, invoice_line_item

provider_entity_id · string · required

Maximum string length: 255

provider_type · string · required

Maximum string length: 50

metadata · object

Response

200

application/json

OK

mapping · object

Show child attributes