Show a subscription plan

Fluid Commerce APIs (1.0)

The Fluid Commerce APIs provides a comprehensive set of APIs designed to integrate Fluid's powerful services into your applications seamlessly. This bundle offers robust functionality for enhancing messaging solutions, streamlining data management, and improving customer interactions. With detailed documentation, secure authentication, and flexible integration options, the Fluid Public API Bundle is engineered to help you leverage our services efficiently and effectively, unlocking new potentials and achieving greater connectivity within your systems.

Download OpenAPI description

swagger.json

swagger.yaml

Overview

E-mail support@fluid.app

License MIT

Servers

Mock server

https://docs.fluid.app/_mock/docs/apis/swagger/

Production server with company subdomain

https://{company}.fluid.app/

Local development server

http://fluid.lvh.me:{port}/

Admins

Operations

Agreements

Operations

Announcements

Operations

ApplePay

Operations

Application Themes

Operations

ApplicationThemeResources

Operations

ApplicationThemeTemplates

Operations

Authentication

Operations

Bank Accounts

Operations

Brand Guidelines

Operations

Business Types

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Callback Schemas

Operations

Carts

Operations

Catch Ups

Operations

Checkout

Operations

Collections

Operations

Companies

Operations

Company Countries

Operations

Contacts

Operations

Countries

Operations

Currencies

Operations

Customer Orders

Operations

CustomerNotes

Operations

Customers

Operations

DAM Query

Operations

Dam

Operations

Default Libraries

Operations

DefaultMySites

Operations

Devices

Operations

Discounts

Operations

Display Settings

Operations

Domains

Operations

Drop Zones

Operations

Droplet Categories

Operations

Droplet Installations

Operations

Droplets

Operations

Enrollment Packs

Operations

Enrollments

Operations

Entities

Operations

FairShare Order Journey

Operations

Fantasy Points

Operations

Feature Flags

Operations

File Resources

Operations

Fluid Orchestration

Operations

Fluid Orchestration - Configurations

Operations

Fluid Orchestration - Rule Based

Operations

Fluid Orchestration - Default Fallback

Operations

Fluid Pay

Operations

Form Elements

Operations

Forms

Operations

GlobalEmbeds

Operations

Impersonation

Operations

Inventory Levels

Operations

Labels

Operations

Languages

Operations

MCC Codes

Operations

Media

Operations

Menus

Operations

Metafield Definitions

Operations

Metafields

Operations

Mobile Widgets

Operations

Multi-Factor Authentications

Operations

Notifications

Operations

Onboarding Info

Operations

Order Fulfillments

Operations

Orders

Operations

Owners

Operations

Pages

Operations

Payment

Operations

Payment Accounts

Operations

Payment Integrations

Operations

Payments Reports

Operations

Paypal

Operations

Points Ledgers

Operations

Points Values

Operations

Posts

Operations

ProductBundles

Operations

ProductImages

Operations

ProductSubscriptionPlans

Operations

Products

Operations

Prompts

Operations

Public Assets

Operations

Public Companies

Operations

Public Drop Zones

Operations

Ranks

Operations

Redirects

Operations

Refunds

Operations

Reps

Operations

Roles

Operations

Root Themes

Operations

Search

Operations

Shop

Operations

Sitemap

Operations

Subscription Plans

Operations

List of subscription plans

Request

List all subscription plans

Query

paginationobject

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/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>'

Responses

success

Bodyapplication/json

subscription_plansArray of objects(Commerce::SubscriptionPlan)required

subscription_plans[].idintegerrequired

subscription_plans[].namestringrequired

Example: "Test Subscription Plan"

subscription_plans[].billing_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription_plans[].billing_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription_plans[].billing_frequency_in_wordsstringrequired

Example: "2 Months"

subscription_plans[].shipping_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription_plans[].shipping_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription_plans[].volume_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription_plans[].volume_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription_plans[].trial_periodinteger or null>= 1

Example: 1

subscription_plans[].trial_period_unitstring or null

Possible values: day, week, month, year

Example: "day"

subscription_plans[].split_volumebooleanrequired

Default false

Example: true

subscription_plans[].allow_skippingboolean or null

Default true

Example: true

subscription_plans[].max_skipsinteger or null>= 1

Example: 1

subscription_plans[].allow_max_billing_cyclesbooleanrequired

Default false

Example: true

subscription_plans[].max_billing_cyclesinteger or null

Example: 3

subscription_plans[].price_adjustment_typestring or null

Example: "percentage or fixed_amount"

subscription_plans[].price_adjustment_amountnumber or null

Example: 10

subscription_plans[].activeboolean or null

Default true

Example: true

subscription_plans[].company_defaultboolean or null

Default false

Example: false

subscription_plans[].created_atstring(date-time)required

Example: "2025-03-10T00:00:00Z"

subscription_plans[].updated_atstring(date-time)required

Example: "2025-03-10T00:00:00Z"

subscription_plans[].products_countinteger or null

Example: 10

subscription_plans[].subscribers_countinteger or null

Example: 10

subscription_plans[].companyobject(Company)required

subscription_plans[].company.idintegerrequired

subscription_plans[].company.namestringrequired

Example: "Acme, Inc."

subscription_plans[].subscriptionsArray of objects(Commerce::Subscription)required

subscription_plans[].subscriptions[].idintegerrequired

subscription_plans[].productsArray of objects(Product)required

subscription_plans[].products[].idintegerrequired

metaobject

Response

application/json

{
  "subscription_plans": [
    { … }
  ],
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z",
    "pagination": { … },
    "bundle_subscriptions_for_company": true
  }
}

Create a subscription plan

Request

Create a subscription plan

Bodyapplication/json

subscription_planobjectrequired

subscription_plan.namestringrequired

subscription_plan.billing_intervalintegerrequired

subscription_plan.billing_interval_unitstringrequired

Enum"day""week""month""year"

subscription_plan.shipping_intervalintegerrequired

subscription_plan.shipping_interval_unitstringrequired

Enum"day""week""month""year"

subscription_plan.volume_intervalintegerrequired

subscription_plan.volume_interval_unitstringrequired

Enum"day""week""month""year"

subscription_plan.trial_periodinteger

subscription_plan.trial_period_unitstring

Enum"day""week""month""year"

subscription_plan.allow_skippingboolean

subscription_plan.max_skipsinteger

subscription_plan.allow_max_billing_cyclesboolean

subscription_plan.max_billing_cyclesinteger

subscription_plan.split_volumeboolean

subscription_plan.price_adjustment_typestring

subscription_plan.price_adjustment_amountnumber

subscription_plan.activeboolean

subscription_plan.company_defaultboolean

product_subscription_plansobject

curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/swagger/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
    }
  }'

Responses

success

Bodyapplication/json

subscription_planobject(Commerce::SubscriptionPlan)required

subscription_plan.idintegerrequired

subscription_plan.namestringrequired

Example: "Test Subscription Plan"

subscription_plan.billing_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription_plan.billing_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription_plan.billing_frequency_in_wordsstringrequired

Example: "2 Months"

subscription_plan.shipping_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription_plan.shipping_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription_plan.volume_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription_plan.volume_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription_plan.trial_periodinteger or null>= 1

Example: 1

subscription_plan.trial_period_unitstring or null

Possible values: day, week, month, year

Example: "day"

subscription_plan.split_volumebooleanrequired

Default false

Example: true

subscription_plan.allow_skippingboolean or null

Default true

Example: true

subscription_plan.max_skipsinteger or null>= 1

Example: 1

subscription_plan.allow_max_billing_cyclesbooleanrequired

Default false

Example: true

subscription_plan.max_billing_cyclesinteger or null

Example: 3

subscription_plan.price_adjustment_typestring or null

Example: "percentage or fixed_amount"

subscription_plan.price_adjustment_amountnumber or null

Example: 10

subscription_plan.activeboolean or null

Default true

Example: true

subscription_plan.company_defaultboolean or null

Default false

Example: false

subscription_plan.created_atstring(date-time)required

Example: "2025-03-10T00:00:00Z"

subscription_plan.updated_atstring(date-time)required

Example: "2025-03-10T00:00:00Z"

subscription_plan.products_countinteger or null

Example: 10

subscription_plan.subscribers_countinteger or null

Example: 10

subscription_plan.companyobject(Company)required

subscription_plan.company.idintegerrequired

subscription_plan.company.namestringrequired

Example: "Acme, Inc."

subscription_plan.subscriptionsArray of objects(Commerce::Subscription)required

subscription_plan.subscriptions[].idintegerrequired

subscription_plan.productsArray of objects(Product)required

subscription_plan.products[].idintegerrequired

metaobject

Response

application/json

{
  "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"
  }
}

Show a subscription plan

Request

Show a subscription plan

Path

idintegerrequired

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/subscription_plans/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

success

Bodyapplication/json

subscription_planobject(Commerce::SubscriptionPlan)required

subscription_plan.idintegerrequired

subscription_plan.namestringrequired

Example: "Test Subscription Plan"

subscription_plan.billing_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription_plan.billing_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription_plan.billing_frequency_in_wordsstringrequired

Example: "2 Months"

subscription_plan.shipping_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription_plan.shipping_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription_plan.volume_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription_plan.volume_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription_plan.trial_periodinteger or null>= 1

Example: 1

subscription_plan.trial_period_unitstring or null

Possible values: day, week, month, year

Example: "day"

subscription_plan.split_volumebooleanrequired

Default false

Example: true

subscription_plan.allow_skippingboolean or null

Default true

Example: true

subscription_plan.max_skipsinteger or null>= 1

Example: 1

subscription_plan.allow_max_billing_cyclesbooleanrequired

Default false

Example: true

subscription_plan.max_billing_cyclesinteger or null

Example: 3

subscription_plan.price_adjustment_typestring or null

Example: "percentage or fixed_amount"

subscription_plan.price_adjustment_amountnumber or null

Example: 10

subscription_plan.activeboolean or null

Default true

Example: true

subscription_plan.company_defaultboolean or null

Default false

Example: false

subscription_plan.created_atstring(date-time)required

Example: "2025-03-10T00:00:00Z"

subscription_plan.updated_atstring(date-time)required

Example: "2025-03-10T00:00:00Z"

subscription_plan.products_countinteger or null

Example: 10

subscription_plan.subscribers_countinteger or null

Example: 10

subscription_plan.companyobject(Company)required

subscription_plan.company.idintegerrequired

subscription_plan.company.namestringrequired

Example: "Acme, Inc."

subscription_plan.subscriptionsArray of objects(Commerce::Subscription)required

subscription_plan.subscriptions[].idintegerrequired

subscription_plan.productsArray of objects(Product)required

subscription_plan.products[].idintegerrequired

metaobject

Response

application/json

{
  "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"
  }
}

Update a subscription plan

Request

Update a subscription plan

Path

idintegerrequired

Bodyapplication/json

subscription_planobjectrequired

subscription_plan.namestringrequired

subscription_plan.billing_intervalintegerrequired

subscription_plan.billing_interval_unitstringrequired

Enum"day""week""month""year"

subscription_plan.shipping_intervalintegerrequired

subscription_plan.shipping_interval_unitstringrequired

Enum"day""week""month""year"

subscription_plan.volume_intervalintegerrequired

subscription_plan.volume_interval_unitstringrequired

Enum"day""week""month""year"

subscription_plan.trial_periodinteger

subscription_plan.trial_period_unitstring

Enum"day""week""month""year"

subscription_plan.allow_skippingboolean

subscription_plan.max_skipsinteger

subscription_plan.allow_max_billing_cyclesboolean

subscription_plan.max_billing_cyclesinteger

subscription_plan.split_volumeboolean

subscription_plan.price_adjustment_typestring

subscription_plan.price_adjustment_amountnumber

subscription_plan.activeboolean

subscription_plan.company_defaultboolean

product_subscription_plansobject

idintegerrequired

curl -i -X PUT \
  'https://docs.fluid.app/_mock/docs/apis/swagger/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
  }'

Responses

success

Bodyapplication/json

subscription_planobject(Commerce::SubscriptionPlan)required

subscription_plan.idintegerrequired

subscription_plan.namestringrequired

Example: "Test Subscription Plan"

subscription_plan.billing_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription_plan.billing_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription_plan.billing_frequency_in_wordsstringrequired

Example: "2 Months"

subscription_plan.shipping_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription_plan.shipping_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription_plan.volume_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription_plan.volume_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription_plan.trial_periodinteger or null>= 1

Example: 1

subscription_plan.trial_period_unitstring or null

Possible values: day, week, month, year

Example: "day"

subscription_plan.split_volumebooleanrequired

Default false

Example: true

subscription_plan.allow_skippingboolean or null

Default true

Example: true

subscription_plan.max_skipsinteger or null>= 1

Example: 1

subscription_plan.allow_max_billing_cyclesbooleanrequired

Default false

Example: true

subscription_plan.max_billing_cyclesinteger or null

Example: 3

subscription_plan.price_adjustment_typestring or null

Example: "percentage or fixed_amount"

subscription_plan.price_adjustment_amountnumber or null

Example: 10

subscription_plan.activeboolean or null

Default true

Example: true

subscription_plan.company_defaultboolean or null

Default false

Example: false

subscription_plan.created_atstring(date-time)required

Example: "2025-03-10T00:00:00Z"

subscription_plan.updated_atstring(date-time)required

Example: "2025-03-10T00:00:00Z"

subscription_plan.products_countinteger or null

Example: 10

subscription_plan.subscribers_countinteger or null

Example: 10

subscription_plan.companyobject(Company)required

subscription_plan.company.idintegerrequired

subscription_plan.company.namestringrequired

Example: "Acme, Inc."

subscription_plan.subscriptionsArray of objects(Commerce::Subscription)required

subscription_plan.subscriptions[].idintegerrequired

subscription_plan.productsArray of objects(Product)required

subscription_plan.products[].idintegerrequired

metaobject

Response

application/json

{
  "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"
  }
}

Delete a subscription plan

Request

Delete a subscription plan

Path

idintegerrequired

curl -i -X DELETE \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/subscription_plans/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

success

Bodyapplication/json

subscription_planobject(Commerce::SubscriptionPlan)required

subscription_plan.idintegerrequired

subscription_plan.namestringrequired

Example: "Test Subscription Plan"

subscription_plan.billing_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription_plan.billing_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription_plan.billing_frequency_in_wordsstringrequired

Example: "2 Months"

subscription_plan.shipping_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription_plan.shipping_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription_plan.volume_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription_plan.volume_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription_plan.trial_periodinteger or null>= 1

Example: 1

subscription_plan.trial_period_unitstring or null

Possible values: day, week, month, year

Example: "day"

subscription_plan.split_volumebooleanrequired

Default false

Example: true

subscription_plan.allow_skippingboolean or null

Default true

Example: true

subscription_plan.max_skipsinteger or null>= 1

Example: 1

subscription_plan.allow_max_billing_cyclesbooleanrequired

Default false

Example: true

subscription_plan.max_billing_cyclesinteger or null

Example: 3

subscription_plan.price_adjustment_typestring or null

Example: "percentage or fixed_amount"

subscription_plan.price_adjustment_amountnumber or null

Example: 10

subscription_plan.activeboolean or null

Default true

Example: true

subscription_plan.company_defaultboolean or null

Default false

Example: false

subscription_plan.created_atstring(date-time)required

Example: "2025-03-10T00:00:00Z"

subscription_plan.updated_atstring(date-time)required

Example: "2025-03-10T00:00:00Z"

subscription_plan.products_countinteger or null

Example: 10

subscription_plan.subscribers_countinteger or null

Example: 10

metaobject

Response

application/json

{
  "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"
  }
}

Delete a product from subscription plan

Request

Delete a product from subscription plan

Path

idintegerrequired

Query

product_idintegerrequired

curl -i -X POST \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/subscription_plans/{id}/remove_product?product_id=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

success

Bodyapplication/json

subscription_planobject(Commerce::SubscriptionPlan)required

subscription_plan.idintegerrequired

subscription_plan.namestringrequired

Example: "Test Subscription Plan"

subscription_plan.billing_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription_plan.billing_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription_plan.billing_frequency_in_wordsstringrequired

Example: "2 Months"

subscription_plan.shipping_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription_plan.shipping_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription_plan.volume_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription_plan.volume_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription_plan.trial_periodinteger or null>= 1

Example: 1

subscription_plan.trial_period_unitstring or null

Possible values: day, week, month, year

Example: "day"

subscription_plan.split_volumebooleanrequired

Default false

Example: true

subscription_plan.allow_skippingboolean or null

Default true

Example: true

subscription_plan.max_skipsinteger or null>= 1

Example: 1

subscription_plan.allow_max_billing_cyclesbooleanrequired

Default false

Example: true

subscription_plan.max_billing_cyclesinteger or null

Example: 3

subscription_plan.price_adjustment_typestring or null

Example: "percentage or fixed_amount"

subscription_plan.price_adjustment_amountnumber or null

Example: 10

subscription_plan.activeboolean or null

Default true

Example: true

subscription_plan.company_defaultboolean or null

Default false

Example: false

subscription_plan.created_atstring(date-time)required

Example: "2025-03-10T00:00:00Z"

subscription_plan.updated_atstring(date-time)required

Example: "2025-03-10T00:00:00Z"

subscription_plan.products_countinteger or null

Example: 10

subscription_plan.subscribers_countinteger or null

Example: 10

metaobject

Response

application/json

{
  "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"
  }
}

Subscriptions

Operations

System Monitoring

Operations

Tax Categories

Operations

Theme Region Rules

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

VariantImages

Operations

VariantInventoryLevels

Operations

Variants

Operations

Warehouses

Operations

Webhook Events

Operations

Webhook Schemas

Operations

Webhooks

Operations

Webhooks Resources

Operations

Get a specific media

Request

Path

idintegerrequired

Media ID

Example: 1

Query

language_isostring

Language code for translations (e.g., 'en', 'es', 'de')

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/media/{id}?language_iso=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Media retrieved successfully

Bodyapplication/json

idintegerrequired

user_idinteger or null

titlestringrequired

descriptionobject or null

strippedstring or null

media_typestringrequired

Enum"share""update""training""upload"

media_formatstring or null

image_urlstring or null

video_urlstring or null

pdf_urlstring or null

kindstring or null

activebooleanrequired

visibilityinteger or null

share_linkstring or null

preview_linkstring or null

viewsintegerrequired

leadsintegerrequired

watchobject or null

video_statusstring or null

durationinteger or null

cta_urlstring or null

cta_button_textstring or null

cta_enabledbooleanrequired

cta_action_typestring or null

video_shopping_enabledbooleanrequired

prompts_enabledbooleanrequired

ranksArray of strings

settingsobject or null

application_theme_template_idinteger or null

created_atstring(date-time)required

subtitlesobject or null

Hash of language ISO codes to subtitle text

countriesArray of objects

tagsArray of objects

slugstring or null

URL-friendly slug for the media item

custom_slugboolean

Whether the slug was customized by the user

promptsArray of objects

Only included if media_type is 'share' or 'upload'

attached_shareablesArray of objects

commentsArray of objects

Only included if video_shopping_enabled is true and display_comments is true

labelobject or null

Label object from LabelConcern

display_tagstring or null

Display tag from LabelConcern

Response

application/json

{
  "id": 0,
  "user_id": 0,
  "title": "string",
  "description": {},
  "stripped": "string",
  "media_type": "share",
  "media_format": "string",
  "image_url": "string",
  "video_url": "string",
  "pdf_url": "string",
  "kind": "string",
  "active": true,
  "visibility": 0,
  "share_link": "string",
  "preview_link": "string",
  "views": 0,
  "leads": 0,
  "watch": {},
  "video_status": "string",
  "duration": 0,
  "cta_url": "string",
  "cta_button_text": "string",
  "cta_enabled": true,
  "cta_action_type": "string",
  "video_shopping_enabled": true,
  "prompts_enabled": true,
  "ranks": [
    "string"
  ],
  "settings": {},
  "application_theme_template_id": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "subtitles": {
    "property1": "string",
    "property2": "string"
  },
  "countries": [
    { … }
  ],
  "tags": [
    { … }
  ],
  "slug": "string",
  "custom_slug": true,
  "prompts": [
    {}
  ],
  "attached_shareables": [
    {}
  ],
  "comments": [
    {}
  ],
  "label": {},
  "display_tag": "string"
}