Addons
Entitlements
Alert Logs
Connections
Costs
Coupons
CreditGrants
Credit Notes
Customers
Wallets
Invoices
- GETGet a customer invoice summary
- GETList invoices
- POSTCreate a new one off invoice
- POSTGet a preview invoice
- POSTList invoices by filter
- GETGet an invoice by ID
- PUTUpdate an invoice
- POSTTrigger communication webhook for an invoice
- POSTFinalize an invoice
- PUTUpdate invoice payment status
- POSTAttempt payment for an invoice
- GETGet PDF for an invoice
- POSTRecalculate invoice totals and line items
- POSTVoid an invoice
Entity Integration Mappings
Environments
Events
Features
Payments
Plans
Prices
Price Units
Integrations
Subscriptions
- GETList subscriptions
- POSTCreate subscription
- POSTAdd addon to subscription
- DELRemove addon from subscription
- PUTUpdate subscription line item
- DELDelete subscription line item
- POSTList subscriptions by filter
- POSTGet usage by subscription
- GETGet subscription
- POSTActivate draft subscription
- POSTCancel subscription
- POSTExecute subscription plan change
- POSTPreview subscription plan change
- GETGet subscription entitlements
- GETGet upcoming credit grant applications
- POSTPause a subscription
- GETList all pauses for a subscription
- POSTResume a paused subscription
Tasks
ScheduledTasks
Tax Associations
Tax Rates
Tenants
Entity Integration Mappings
Get entity integration mapping
Retrieve a specific entity integration mapping by ID
GET
/
entity-integration-mappings
/
{id}
Get entity integration mapping
Copy
curl --request GET \
--url https://api.cloud.flexprice.io/v1/entity-integration-mappings/{id} \
--header 'x-api-key: <api-key>'Copy
{
"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
Enter your API key in the format x-api-key <api-key>*
Path Parameters
Entity integration mapping ID
Response
OK
Available options:
customer, plan, invoice, subscription, payment, credit_note, addon, item, item_price, price Available options:
published, deleted, archived ⌘I
Get entity integration mapping
Copy
curl --request GET \
--url https://api.cloud.flexprice.io/v1/entity-integration-mappings/{id} \
--header 'x-api-key: <api-key>'Copy
{
"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>"
}