Authorizations
Enter your API key in the format x-api-key <api-key>*
Path Parameters
Group ID
Addons
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
Entitlements
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
- POSTCancel subscription
- POSTExecute subscription plan change
- POSTPreview subscription plan change
- POSTPause a subscription
- GETList all pauses for a subscription
- POSTAdd new phase to subscription schedule
- POSTResume a paused subscription
Tasks
ScheduledTasks
Tax Associations
Tax Rates
Tenants
Users
Groups
Get a group
Get a group by ID
GET
/
groups
/
{id}
Get a group
Copy
curl --request GET \
--url https://api.cloud.flexprice.io/v1/groups/{id} \
--header 'x-api-key: <api-key>'Copy
{
"created_at": "<string>",
"entity_ids": [
"<string>"
],
"entity_type": "<string>",
"id": "<string>",
"lookup_key": "<string>",
"metadata": {},
"name": "<string>",
"status": "<string>",
"updated_at": "<string>"
}⌘I
Get a group
Copy
curl --request GET \
--url https://api.cloud.flexprice.io/v1/groups/{id} \
--header 'x-api-key: <api-key>'Copy
{
"created_at": "<string>",
"entity_ids": [
"<string>"
],
"entity_type": "<string>",
"id": "<string>",
"lookup_key": "<string>",
"metadata": {},
"name": "<string>",
"status": "<string>",
"updated_at": "<string>"
}