Provide cancellation feedback for subscription order

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}/

Agreements

Operations

ApplePay

Operations

Application Themes

Operations

ApplicationThemeTemplates

Operations

Authentication

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Carts

Operations

Company Custom Catch Ups

Operations

Company Discounts

Operations

Company Droplets

Operations

Company Pages

Operations

Company Popups

Operations

Company Settings - Checkout

Operations

Company Settings - Countries

Operations

Company Settings - Languages

Operations

Company Settings - Warehouses

Operations

Contacts

Operations

Currencies

Operations

Customer Orders

Operations

CustomerNotes

Operations

Customers

Operations

Domains

Operations

Drop Zones

Operations

Droplets

Operations

Enrollment Packs

Operations

Enrollments

Operations

Fantasy Points

Operations

Fluid Pay

Operations

GlobalEmbeds

Operations

Inventory Levels

Operations

Multi-Factor Authentications

Operations

Notifications

Operations

Order Fulfillments

Operations

Orders

Operations

Pages

Operations

Payment

Operations

Payment Accounts

Operations

Payments

Operations

Paypal

Operations

Products

Operations

Public Companies

Operations

Redirects

Operations

Refunds

Operations

Roles

Operations

Subscription Orders

Operations

List Subscription Orders

Request

Get all subscription orders with optional filters

Query

customer_idinteger

Filter subscription orders by customer_id

buyer_idinteger

Filter subscription orders by buyer_id

user_company_idinteger

Filter subscription orders by user_company_id

ship_to_country_idstring

Filter subscription orders by shipping address' country

next_bill_date_start_datestring

Filter subscription orders by start_date of next_bill_date

next_bill_date_end_datestring

Filter subscription orders by end_date of next_bill_date

pageinteger

Page number for pagination

Default 1

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/v2/subscription_orders?buyer_id=0&customer_id=0&next_bill_date_end_date=string&next_bill_date_start_date=string&page=1&ship_to_country_id=string&user_company_id=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful

Bodyapplication/json

subscription_ordersArray of objects

metaobject

Response

application/json

{
  "subscription_orders": [
    { … }
  ],
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z",
    "total_count": 42,
    "total_pages": 3,
    "current_page": 1
  }
}

Retrieve a Subscription Order

Request

Retrieve a single subscription order by ID

Path

idstringrequired

ID of the subscription order

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

Responses

successful

Bodyapplication/json

subscription_orderobject

metaobject

Response

application/json

{
  "subscription_order": {
    "id": 0,
    "order_number": "string",
    "amount": 0,
    "display_amount": "string",
    "subtotal": 0,
    "display_subtotal": "string",
    "tax": 0,
    "display_tax": "string",
    "discount": 0,
    "display_discount": "string",
    "shipping": 0,
    "display_shipping": "string",
    "total": 0,
    "display_total": "string",
    "created_at": "string",
    "updated_at": "string",
    "bill_date": "string",
    "next_bill_date": "string",
    "days_until_next_bill_date": 0,
    "status": "string",
    "subscription_interval": 0,
    "cancellation_reason": "string",
    "additional_feedback": "string",
    "bill_to": { … },
    "ship_to": { … },
    "order_thumbnail": "string",
    "customer": { … },
    "user": { … },
    "buyer": { … },
    "payment_method": { … },
    "items": [ … ],
    "activities": [ … ]
  },
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Update subscription order

Request

Update subscription order

Path

idstringrequired

Bodyapplication/json

updateboolean or null

itemsArray of objects

curl -i -X PATCH \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/v2/subscription_orders/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "update": true,
    "items": [
      {
        "id": 0,
        "quantity": 0,
        "option_value_ids": [
          0
        ]
      }
    ]
  }'

Responses

successful

Bodyapplication/json

subscription_orderobject

metaobject

Response

application/json

{
  "subscription_order": {
    "id": 0,
    "amount": 0,
    "display_amount": "string",
    "subtotal": 0,
    "display_subtotal": "string",
    "tax": 0,
    "display_tax": "string",
    "discount": 0,
    "display_discount": "string",
    "shipping": 0,
    "display_shipping": "string",
    "total": 0,
    "display_total": "string",
    "created_at": "string",
    "updated_at": "string",
    "bill_date": "string",
    "next_bill_date": "string",
    "days_until_next_bill_date": 0,
    "status": "string",
    "subscription_interval": 0,
    "cancellation_reason": "string",
    "additional_feedback": "string",
    "bill_to": { … },
    "ship_to": { … },
    "order_thumbnail": "string",
    "customer": { … },
    "user": { … },
    "buyer": { … },
    "payment_method": { … },
    "items": [ … ],
    "activities": [ … ]
  },
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Subscription Orders' stats

Request

Get statistics for subscription orders with optional filters

Query

customer_idinteger

Filter subscription orders by customer_id

buyer_idinteger

Filter subscription orders by buyer_id

ship_to_country_idstring

Filter subscription orders by shipping address' country

next_bill_date_start_datestring

Filter subscription orders by start_date of next_bill_date

next_bill_date_end_datestring

Filter subscription orders by end_date of next_bill_date

pageinteger

Page number for pagination

Default 1

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/v2/subscription_orders/stats?buyer_id=0&customer_id=0&next_bill_date_end_date=string&next_bill_date_start_date=string&page=1&ship_to_country_id=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful

Bodyapplication/json

subscriptions_countinteger

active_subscriptions_countinteger

cancelled_subscriptions_countinteger

metaobject

Response

application/json

{
  "subscriptions_count": 0,
  "active_subscriptions_count": 0,
  "cancelled_subscriptions_count": 0,
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Update shipping address for Subscription Order

Request

Update shipping address of a subscription order

Path

idstringrequired

Bodyapplication/json

address

addressobject

curl -i -X PATCH \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/v2/subscription_orders/{id}/update_shipping_address' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "address": {
      "country_id": 0,
      "name": "string",
      "address1": "string",
      "address2": "string",
      "city": "string",
      "state": "string",
      "postal_code": "string"
    }
  }'

Responses

successful

Bodyapplication/json

subscription_orderobject

metaobject

Response

application/json

{
  "subscription_order": {
    "id": 0,
    "amount": 0,
    "display_amount": "string",
    "subtotal": 0,
    "display_subtotal": "string",
    "tax": 0,
    "display_tax": "string",
    "discount": 0,
    "display_discount": "string",
    "shipping": 0,
    "display_shipping": "string",
    "total": 0,
    "display_total": "string",
    "created_at": "string",
    "updated_at": "string",
    "bill_date": "string",
    "next_bill_date": "string",
    "days_until_next_bill_date": 0,
    "status": "string",
    "subscription_interval": 0,
    "cancellation_reason": "string",
    "additional_feedback": "string",
    "bill_to": { … },
    "ship_to": { … },
    "order_thumbnail": "string",
    "customer": { … },
    "user": { … },
    "buyer": { … },
    "payment_method": { … },
    "items": [ … ],
    "activities": [ … ]
  },
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Update payment method of a subscription order

Request

Update payment method of a subscription order

Path

idstringrequired

Bodyapplication/json

Supports multiple payment methods, each of which have their own parameter signatures. Please peek into the schema for more details.

One of:

payment_methodstringrequired

Value"paypal"

return_urlstringrequired

Return URL passed into Paypal payload

cancel_urlstringrequired

Cancel URL passed into Paypal payload

curl -i -X PATCH \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/v2/subscription_orders/{id}/update_payment' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "payment_method": "card",
    "card_id": 0
  }'

Responses

successful

Bodyapplication/json

Any of:

This schema is returned when 'payment_method' is anything but 'paypal'.

subscription_orderobject

metaobject

Response

application/json

{
  "payer_action_url": "https://www.paypal.com/mock_redirect_url",
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Skip an order of subscription order

Request

Skip an order of subscription order

Path

idstringrequired

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

Responses

successful

Bodyapplication/json

subscription_orderobject

metaobject

Response

application/json

{
  "subscription_order": {
    "id": 0,
    "amount": 0,
    "display_amount": "string",
    "subtotal": 0,
    "display_subtotal": "string",
    "tax": 0,
    "display_tax": "string",
    "discount": 0,
    "display_discount": "string",
    "shipping": 0,
    "display_shipping": "string",
    "total": 0,
    "display_total": "string",
    "created_at": "string",
    "updated_at": "string",
    "bill_date": "string",
    "next_bill_date": "string",
    "days_until_next_bill_date": 0,
    "status": "string",
    "subscription_interval": 0,
    "cancellation_reason": "string",
    "additional_feedback": "string",
    "bill_to": { … },
    "ship_to": { … },
    "order_thumbnail": "string",
    "customer": { … },
    "user": { … },
    "buyer": { … },
    "payment_method": { … },
    "items": [ … ],
    "activities": [ … ]
  },
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Cancel subscription order

Request

Cancel subscription order

Path

idstringrequired

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

Responses

successful

Bodyapplication/json

subscription_orderobject

metaobject

Response

application/json

{
  "subscription_order": {
    "id": 0,
    "amount": 0,
    "display_amount": "string",
    "subtotal": 0,
    "display_subtotal": "string",
    "tax": 0,
    "display_tax": "string",
    "discount": 0,
    "display_discount": "string",
    "shipping": 0,
    "display_shipping": "string",
    "total": 0,
    "display_total": "string",
    "created_at": "string",
    "updated_at": "string",
    "bill_date": "string",
    "next_bill_date": "string",
    "days_until_next_bill_date": 0,
    "status": "string",
    "subscription_interval": 0,
    "cancellation_reason": "string",
    "additional_feedback": "string",
    "bill_to": { … },
    "ship_to": { … },
    "order_thumbnail": "string",
    "customer": { … },
    "user": { … },
    "buyer": { … },
    "payment_method": { … },
    "items": [ … ],
    "activities": [ … ]
  },
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Provide cancellation feedback for subscription order

Request

Provide cancellation feedback for subscription order

Path

idstringrequired

Bodyapplication/json

reasonstring

feedbackstring

curl -i -X PATCH \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/v2/subscription_orders/{id}/cancellation_feedback' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "reason": "string",
    "feedback": "string"
  }'

Responses

successful

Bodyapplication/json

subscription_orderobject

metaobject

Response

application/json

{
  "subscription_order": {
    "id": 0,
    "amount": 0,
    "display_amount": "string",
    "subtotal": 0,
    "display_subtotal": "string",
    "tax": 0,
    "display_tax": "string",
    "discount": 0,
    "display_discount": "string",
    "shipping": 0,
    "display_shipping": "string",
    "total": 0,
    "display_total": "string",
    "created_at": "string",
    "updated_at": "string",
    "bill_date": "string",
    "next_bill_date": "string",
    "days_until_next_bill_date": 0,
    "status": "string",
    "subscription_interval": 0,
    "cancellation_reason": "string",
    "additional_feedback": "string",
    "bill_to": { … },
    "ship_to": { … },
    "order_thumbnail": "string",
    "customer": { … },
    "user": { … },
    "buyer": { … },
    "payment_method": { … },
    "items": [ … ],
    "activities": [ … ]
  },
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Authorize paypal payment for subscription order

Request

Authorize paypal payment for subscription order.This endpoint is passed as return_url in Paypal's payload, and PayPal redirects to this URL after completing the relevant action.

Path

idstringrequired

Query

tokenstringrequired

Authorization token from Paypal

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

Responses

successful

Bodyapplication/json

subscription_orderobject

metaobject

Response

application/json

{
  "subscription_order": {
    "id": 0,
    "amount": 0,
    "display_amount": "string",
    "subtotal": 0,
    "display_subtotal": "string",
    "tax": 0,
    "display_tax": "string",
    "discount": 0,
    "display_discount": "string",
    "shipping": 0,
    "display_shipping": "string",
    "total": 0,
    "display_total": "string",
    "created_at": "string",
    "updated_at": "string",
    "bill_date": "string",
    "next_bill_date": "string",
    "days_until_next_bill_date": 0,
    "status": "string",
    "subscription_interval": 0,
    "cancellation_reason": "string",
    "additional_feedback": "string",
    "bill_to": { … },
    "ship_to": { … },
    "order_thumbnail": "string",
    "customer": { … },
    "user": { … },
    "buyer": { … },
    "payment_method": { … },
    "items": [ … ],
    "activities": [ … ]
  },
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Send autoship reminder email

Request

Send autoship reminder email to customer manually

Path

idstringrequired

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

Responses

successful

Bodyapplication/json

idintegerrequired

Example: "1"

metaobject

Response

application/json

{
  "id": "1",
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Subscription Plans

Operations

Subscriptions

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

Webhooks

Operations

returns a list of all droplet categories

Request

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

Responses

returns a list of droplet categories

Bodyapplication/json

droplet_categoriesArray of objects(DropletCategory)

metaobject

Response

application/json

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

Fluid Commerce APIs (1.0)

Agreements

ApplePay

Application Themes

ApplicationThemeTemplates

Authentication

Callback Definitions

Callback Registrations

Carts

Company Custom Catch Ups

Company Discounts

Company Droplets

Company Pages

Company Popups

Company Settings - Checkout

Company Settings - Countries

Company Settings - Languages

Company Settings - Social Media

Company Settings - Warehouses

Contacts

Currencies

Customer Orders

CustomerNotes

Customers

Domains

Drop Zones

Droplets

Enrollment Packs

Enrollments

Fantasy Points

Fluid Pay

GlobalEmbeds

Inventory Levels

Multi-Factor Authentications

Notifications

Order Fulfillments

Orders

Pages

Payment

Payment Accounts

Payments

Paypal

Products

Public Companies

Redirects

Refunds

Roles

Shares

Subscription Orders

List Subscription Orders

Request

Responses

Was this helpful?

Retrieve a Subscription Order

Request

Responses

Was this helpful?

Update subscription order

RequestExpand all

Responses

Was this helpful?

Subscription Orders' stats

Request

Responses

Was this helpful?

Update shipping address for Subscription Order

RequestExpand all

Responses

Was this helpful?

Update payment method of a subscription order

Request

Responses

Was this helpful?

Skip an order of subscription order

Request

Responses

Was this helpful?

Cancel subscription order

Request

Responses

Request

Request