Skip to main content

Plans & Organizations on API Products

API Products can have plans attached (for rate limiting and access tiers) and can be restricted to specific organizations.

Manage plans on a product​

Add a plan to a product​

curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/apiProducts/<product-id>/plans/<plan-id>" \
  -H "Authorization: Bearer <your-token>"

Remove a plan from a product​

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

List plans on a product​

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

Manage allowed organizations​

When a product's visibility is set to RESTRICTED, only specific organizations can access it.

Add an allowed organization​

curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/apiProducts/<product-id>/organizations/<organization-id>" \
  -H "Authorization: Bearer <your-token>"

Remove an allowed organization​

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

List allowed organizations​

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

Manage terms of use on a product​

Attach terms of use​

curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/apiProducts/<product-id>/termsOfUse/<terms-id>" \
  -H "Authorization: Bearer <your-token>"

Remove terms of use​

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