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": {}
}
'from flexprice import Flexprice
with Flexprice(
api_key_auth="<YOUR_API_KEY_HERE>",
) as f_client:
res = f_client.integrations.link_integration_mapping(entity_id="<id>", entity_type="invoice_line_item", provider_entity_id="<id>", provider_type="<value>")
# Handle response
print(res)import { Flexprice } from "@flexprice/sdk";
const flexprice = new Flexprice({
apiKeyAuth: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await flexprice.integrations.linkIntegrationMapping({
entityId: "<id>",
entityType: "invoice_line_item",
providerEntityId: "<id>",
providerType: "<value>",
});
console.log(result);
}
run();package main
import(
"context"
flexprice "github.com/flexprice/go-sdk/v2"
"github.com/flexprice/go-sdk/v2/models/types"
"log"
)
func main() {
ctx := context.Background()
s := flexprice.New(
flexprice.WithSecurity("<YOUR_API_KEY_HERE>"),
)
res, err := s.Integrations.LinkIntegrationMapping(ctx, types.LinkIntegrationMappingRequest{
EntityID: "<id>",
EntityType: types.IntegrationEntityTypeInvoiceLineItem,
ProviderEntityID: "<id>",
ProviderType: "<value>",
})
if err != nil {
log.Fatal(err)
}
if res.LinkIntegrationMappingResponse != nil {
// handle response
}
}{
"mapping": {
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"entity_id": "<string>",
"entity_type": "customer",
"environment_id": "<string>",
"id": "<string>",
"metadata": {},
"provider_entity_id": "<string>",
"provider_type": "<string>",
"status": "published",
"tenant_id": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "<string>"
}
}{
"code": "http_client_error",
"http_status_code": 123,
"message": "<string>"
}{
"code": "http_client_error",
"http_status_code": 123,
"message": "<string>"
}Integrations
Link integration mapping
Link a FlexPrice entity to provider entity with provider-specific side effects.
POST
/
integrations
/
link
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": {}
}
'from flexprice import Flexprice
with Flexprice(
api_key_auth="<YOUR_API_KEY_HERE>",
) as f_client:
res = f_client.integrations.link_integration_mapping(entity_id="<id>", entity_type="invoice_line_item", provider_entity_id="<id>", provider_type="<value>")
# Handle response
print(res)import { Flexprice } from "@flexprice/sdk";
const flexprice = new Flexprice({
apiKeyAuth: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await flexprice.integrations.linkIntegrationMapping({
entityId: "<id>",
entityType: "invoice_line_item",
providerEntityId: "<id>",
providerType: "<value>",
});
console.log(result);
}
run();package main
import(
"context"
flexprice "github.com/flexprice/go-sdk/v2"
"github.com/flexprice/go-sdk/v2/models/types"
"log"
)
func main() {
ctx := context.Background()
s := flexprice.New(
flexprice.WithSecurity("<YOUR_API_KEY_HERE>"),
)
res, err := s.Integrations.LinkIntegrationMapping(ctx, types.LinkIntegrationMappingRequest{
EntityID: "<id>",
EntityType: types.IntegrationEntityTypeInvoiceLineItem,
ProviderEntityID: "<id>",
ProviderType: "<value>",
})
if err != nil {
log.Fatal(err)
}
if res.LinkIntegrationMappingResponse != nil {
// handle response
}
}{
"mapping": {
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"entity_id": "<string>",
"entity_type": "customer",
"environment_id": "<string>",
"id": "<string>",
"metadata": {},
"provider_entity_id": "<string>",
"provider_type": "<string>",
"status": "published",
"tenant_id": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "<string>"
}
}{
"code": "http_client_error",
"http_status_code": 123,
"message": "<string>"
}{
"code": "http_client_error",
"http_status_code": 123,
"message": "<string>"
}Authorizations
Enter your API key in the format x-api-key <api-key>*
Body
application/json
Link mapping request
Maximum string length:
255Available options:
customer, plan, invoice, subscription, payment, credit_note, addon, item, item_price, price, invoice_line_item, subscription_line_item Maximum string length:
255Maximum string length:
50Response
OK
Show child attributes
Show child attributes

