The Fluid Company APIs provide a comprehensive set of APIs designed to integrate Fluid's powerful services into your applications seamlessly. These APIs use Company API tokens for authentication and provide full access to manage your company's resources including users, orders, products, media, and more.
For APIs that authenticate with User tokens, see the Rep APIs documentation.
curl -i -X GET \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/subscription_plans?active=true&page=0&per_page=100&product=0&search_query=string&sort_direction=string&sorted_by=string' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "subscription_plans": [ { … } ], "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z", "pagination": { … }, "bundle_subscriptions_for_company": true } }
curl -i -X POST \ https://docs.fluid.app/_mock/docs/apis/company.api/api/subscription_plans \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "subscription_plan": { "name": "string", "billing_interval": 0, "billing_interval_unit": "day", "shipping_interval": 0, "shipping_interval_unit": "day", "volume_interval": 0, "volume_interval_unit": "day", "trial_period": 0, "trial_period_unit": "day", "allow_skipping": true, "max_skips": 0, "allow_max_billing_cycles": true, "max_billing_cycles": 0, "split_volume": true, "price_adjustment_type": "string", "price_adjustment_amount": 0, "active": true, "company_default": true }, "product_subscription_plans": { "product_id": 0, "default": true } }'
{ "subscription_plan": { "id": 0, "name": "Test Subscription Plan", "billing_interval": 1, "billing_interval_unit": "day", "billing_frequency_in_words": "2 Months", "shipping_interval": 1, "shipping_interval_unit": "day", "volume_interval": 1, "volume_interval_unit": "day", "trial_period": 1, "trial_period_unit": "day", "split_volume": true, "allow_skipping": true, "max_skips": 1, "allow_max_billing_cycles": true, "max_billing_cycles": 3, "price_adjustment_type": "percentage or fixed_amount", "price_adjustment_amount": 10, "active": true, "company_default": false, "created_at": "2025-03-10T00:00:00Z", "updated_at": "2025-03-10T00:00:00Z", "products_count": 10, "subscribers_count": 10, "company": { … }, "subscriptions": [ … ], "products": [ … ] }, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }
curl -i -X GET \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/subscription_plans/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "subscription_plan": { "id": 0, "name": "Test Subscription Plan", "billing_interval": 1, "billing_interval_unit": "day", "billing_frequency_in_words": "2 Months", "shipping_interval": 1, "shipping_interval_unit": "day", "volume_interval": 1, "volume_interval_unit": "day", "trial_period": 1, "trial_period_unit": "day", "split_volume": true, "allow_skipping": true, "max_skips": 1, "allow_max_billing_cycles": true, "max_billing_cycles": 3, "price_adjustment_type": "percentage or fixed_amount", "price_adjustment_amount": 10, "active": true, "company_default": false, "created_at": "2025-03-10T00:00:00Z", "updated_at": "2025-03-10T00:00:00Z", "products_count": 10, "subscribers_count": 10, "company": { … }, "subscriptions": [ … ], "products": [ … ] }, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }
curl -i -X PUT \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/subscription_plans/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "subscription_plan": { "name": "string", "billing_interval": 0, "billing_interval_unit": "day", "shipping_interval": 0, "shipping_interval_unit": "day", "volume_interval": 0, "volume_interval_unit": "day", "trial_period": 0, "trial_period_unit": "day", "allow_skipping": true, "max_skips": 0, "allow_max_billing_cycles": true, "max_billing_cycles": 0, "split_volume": true, "price_adjustment_type": "string", "price_adjustment_amount": 0, "active": true, "company_default": true }, "product_subscription_plans": { "id": 0, "product_id": 0, "default": true, "company_default": true }, "id": 0 }'
{ "subscription_plan": { "id": 0, "name": "Test Subscription Plan", "billing_interval": 1, "billing_interval_unit": "day", "billing_frequency_in_words": "2 Months", "shipping_interval": 1, "shipping_interval_unit": "day", "volume_interval": 1, "volume_interval_unit": "day", "trial_period": 1, "trial_period_unit": "day", "split_volume": true, "allow_skipping": true, "max_skips": 1, "allow_max_billing_cycles": true, "max_billing_cycles": 3, "price_adjustment_type": "percentage or fixed_amount", "price_adjustment_amount": 10, "active": true, "company_default": false, "created_at": "2025-03-10T00:00:00Z", "updated_at": "2025-03-10T00:00:00Z", "products_count": 10, "subscribers_count": 10, "company": { … }, "subscriptions": [ … ], "products": [ … ] }, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }
curl -i -X DELETE \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/subscription_plans/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "subscription_plan": { "id": 0, "name": "Test Subscription Plan", "billing_interval": 1, "billing_interval_unit": "day", "billing_frequency_in_words": "2 Months", "shipping_interval": 1, "shipping_interval_unit": "day", "volume_interval": 1, "volume_interval_unit": "day", "trial_period": 1, "trial_period_unit": "day", "split_volume": true, "allow_skipping": true, "max_skips": 1, "allow_max_billing_cycles": true, "max_billing_cycles": 3, "price_adjustment_type": "percentage or fixed_amount", "price_adjustment_amount": 10, "active": true, "company_default": false, "created_at": "2025-03-10T00:00:00Z", "updated_at": "2025-03-10T00:00:00Z", "products_count": 10, "subscribers_count": 10 }, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }
curl -i -X POST \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/subscription_plans/{id}/remove_product?product_id=0' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "subscription_plan": { "id": 0, "name": "Test Subscription Plan", "billing_interval": 1, "billing_interval_unit": "day", "billing_frequency_in_words": "2 Months", "shipping_interval": 1, "shipping_interval_unit": "day", "volume_interval": 1, "volume_interval_unit": "day", "trial_period": 1, "trial_period_unit": "day", "split_volume": true, "allow_skipping": true, "max_skips": 1, "allow_max_billing_cycles": true, "max_billing_cycles": 3, "price_adjustment_type": "percentage or fixed_amount", "price_adjustment_amount": 10, "active": true, "company_default": false, "created_at": "2025-03-10T00:00:00Z", "updated_at": "2025-03-10T00:00:00Z", "products_count": 10, "subscribers_count": 10 }, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }
Social Media