Manage Subscriptions

This guide covers creating, listing, updating, and deleting subscriptions between applications and API Products.

List subscriptions

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/subscriptions" \
  -H "Authorization: Bearer <your-token>"

Filter parameters

Parameter	Type	Description
application	UUID	Filter by application
apiProduct	UUID	Filter by API product
environment	UUID	Filter by environment
approvalStatus	string	APPROVED, PENDING, or DECLINED

Create a subscription

curl -X POST "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/subscriptions" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "application": "<application-id>",
    "apiProduct": "<product-id>",
    "plan": "<plan-id>"
  }'

Required fields

Field	Type	Description
application	UUID	The subscribing application
apiProduct	UUID	The API Product to subscribe to
plan	UUID	The plan to use

note

If the API Product requires approval, the subscription will be created with approvalStatus: "PENDING" and must be approved before it becomes active.

Get a subscription

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/subscriptions/<subscription-id>" \
  -H "Authorization: Bearer <your-token>"

Update a subscription

curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/subscriptions/<subscription-id>" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "plan": "<new-plan-id>"
  }'

Delete a subscription

curl -X DELETE "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/subscriptions/<subscription-id>" \
  -H "Authorization: Bearer <your-token>"

Deploy a subscription

Deploy a subscription to an environment:

curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/environments/<environment-id>/subscriptions/<subscription-id>" \
  -H "Authorization: Bearer <your-token>"

Undeploy a subscription

curl -X DELETE "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/environments/<environment-id>/subscriptions/<subscription-id>" \
  -H "Authorization: Bearer <your-token>"