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://fluid-commerce.redocly.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

ApplePay

Operations

Application Theme Templates

Operations

Application Themes

Operations

ApplicationThemeTemplates

Operations

Authentication

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Callback Schemas

Operations

Carts

Operations

Collections

Operations

Companies

Operations

Company Admins

Operations

Company Custom Catch Ups

Operations

Company Discounts

Operations

Company Mobile Widgets

Operations

Company Pages

Operations

Pages

Operations

Company Popups

Operations

Company Settings - Checkout

Operations

Company Settings - Countries

Operations

Company Settings - Languages

Operations

Company Settings - Warehouses

Operations

Company Webhook Events

Operations

Contacts

Operations

Currencies

Operations

Customer Orders

Operations

CustomerNotes

Operations

Customers

Operations

DAM Query

Operations

Dam

Operations

Default Libraries

Operations

DefaultMySites

Operations

Devices

Operations

Display Settings

Operations

Domains

Operations

Drop Zones

Operations

Droplet Categories

Operations

Droplet Installations

Operations

Droplets

Operations

Enrollment Packs

Operations

Enrollments

Operations

FairShare Order Journey

Operations

Fantasy Points

Operations

Feature Flags

Operations

File Resources

Operations

Fluid Pay

Operations

Form Elements

Operations

Forms

Operations

GlobalEmbeds

Operations

Impersonation

Operations

Inventory Levels

Operations

Labels

Operations

Menus

Operations

Metafield Definitions

Operations

Multi Factor Authentications

Operations

Multi-Factor Authentications

Operations

Notifications

Operations

Onboarding

Operations

Order Fulfillments

Operations

Orders

Operations

Payment

Operations

Payment Accounts

Operations

Payment Integrations

Operations

Payments

Operations

Paypal

Operations

Products

Operations

Prompts

Operations

Public Companies

Operations

Public Drop Zones

Operations

Ranks

Operations

Redirects

Operations

Refunds

Operations

Reps

Operations

Roles

Operations

Settings

Operations

Settings - Companies

Operations

Shop

Operations

Subscription Plans

Operations

Subscriptions

Operations

List of subscriptions

Request

List all subscriptions

Query

pageinteger

Page number for pagination

Default 1

per_pageinteger

Number of records per page

Default 25

statusstring

Filter subscriptions by status (can be comma-separated for multiple values)

Enum"pending""active""paused""past_due""cancelled""trial"

Example: status=active

subscription_plan_idinteger

Filter subscriptions by subscription plan ID

customer_idinteger

Filter subscriptions by customer ID

within_daysinteger

Filter subscriptions within number of days (e.g., last 7 days)

frequencystring

Filter subscriptions by billing frequency. Supported values: day, week, month, year

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

subscription_number_mininteger

Minimum subscription number for filtering

subscription_number_maxinteger

Maximum subscription number for filtering

amount_minnumber

Minimum amount for filtering

amount_maxnumber

Maximum amount for filtering

created_startstring(date)

Start date for created date range filter (format: YYYY-MM-DD)

created_endstring(date)

End date for created date range filter (format: YYYY-MM-DD)

next_bill_startstring(date)

Start date for next bill date range filter (format: YYYY-MM-DD)

next_bill_endstring(date)

End date for next bill date range filter (format: YYYY-MM-DD)

last_bill_startstring(date)

Start date for last bill date range filter (format: YYYY-MM-DD)

last_bill_endstring(date)

End date for last bill date range filter (format: YYYY-MM-DD)

next_ship_startstring(date)

Start date for next ship date range filter (format: YYYY-MM-DD)

next_ship_endstring(date)

End date for next ship date range filter (format: YYYY-MM-DD)

last_ship_startstring(date)

Start date for last ship date range filter (format: YYYY-MM-DD)

last_ship_endstring(date)

End date for last ship date range filter (format: YYYY-MM-DD)

last_failed_startstring(date)

Start date for last failed date range filter (format: YYYY-MM-DD)

last_failed_endstring(date)

End date for last failed date range filter (format: YYYY-MM-DD)

cancelled_startstring(date)

Start date for cancelled date range filter (format: YYYY-MM-DD)

cancelled_endstring(date)

End date for cancelled date range filter (format: YYYY-MM-DD)

sort_bystring

Sort field for subscriptions

Enum"created_at""id""next_bill_date""customer""last_bill_date""product""amount""status""frequency"

sort_directionstring

Sort direction

Default "desc"

Enum"asc""desc"

searchstring

Search term for subscriptions(searches across subscription plan names, customer details, and product titles)

curl -i -X GET \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/subscriptions?amount_max=0&amount_min=0&cancelled_end=2019-08-24&cancelled_start=2019-08-24&created_end=2019-08-24&created_start=2019-08-24&customer_id=0&frequency=day&last_bill_end=2019-08-24&last_bill_start=2019-08-24&last_failed_end=2019-08-24&last_failed_start=2019-08-24&last_ship_end=2019-08-24&last_ship_start=2019-08-24&next_bill_end=2019-08-24&next_bill_start=2019-08-24&next_ship_end=2019-08-24&next_ship_start=2019-08-24&page=1&per_page=25&search=string&sort_by=created_at&sort_direction=asc&status=pending&subscription_number_max=0&subscription_number_min=0&subscription_plan_id=0&within_days=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

success

Bodyapplication/json

subscriptionsArray of objects(Commerce::Subscription)required

subscriptions[].idintegerrequired

subscriptions[].subscription_tokenstringrequired

Example: "sb_1234567890"

subscriptions[].next_bill_datestring or nullrequired

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

subscriptions[].last_bill_datestring or null(date)

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

subscriptions[].next_ship_datestring or null(date)

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

subscriptions[].last_ship_datestring or null(date)

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

subscriptions[].statusstringrequired

Enum"pending""active""paused""past_due""cancelled""trial"

Example: "active"

subscriptions[].disabledboolean or null

Default false

Example: false

subscriptions[].quantityinteger>= 1required

Default 1

Example: 1

subscriptions[].pricenumberrequired

Example: 100

subscriptions[].original_pricenumberrequired

Example: 100

subscriptions[].attemptsinteger or null

Default 0

Example: 1

subscriptions[].last_failed_atstring or null(date-time)

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

subscriptions[].next_retry_atstring or null(date-time)

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

subscriptions[].skipped_countinteger or null

Default 0

Example: 1

subscriptions[].max_skipsinteger or null

Example: 1

subscriptions[].trial_ends_atstring or null(date-time)

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

subscriptions[].cancelled_atstring or null(date-time)

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

subscriptions[].created_atstring(date-time)required

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

subscriptions[].updated_atstring(date-time)required

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

subscriptions[].notesstring or null

Example: "This is a sample commerce subscription"

subscriptions[].in_trialbooleanrequired

Example: false

subscriptions[].subscription_planobject(Commerce::SubscriptionPlan)required

subscriptions[].subscription_plan.idintegerrequired

subscriptions[].subscription_plan.namestringrequired

Example: "Test Subscription Plan"

subscriptions[].subscription_plan.billing_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscriptions[].subscription_plan.billing_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscriptions[].subscription_plan.billing_frequency_in_wordsstringrequired

Example: "2 Months"

subscriptions[].subscription_plan.shipping_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscriptions[].subscription_plan.shipping_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscriptions[].subscription_plan.volume_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscriptions[].subscription_plan.volume_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscriptions[].subscription_plan.trial_periodinteger or null>= 1

Example: 1

subscriptions[].subscription_plan.trial_period_unitstring or null

Possible values: day, week, month, year

Example: "day"

subscriptions[].subscription_plan.split_volumebooleanrequired

Default false

Example: true

subscriptions[].subscription_plan.allow_skippingboolean or null

Default true

Example: true

subscriptions[].subscription_plan.max_skipsinteger or null>= 1

Example: 1

subscriptions[].subscription_plan.price_adjustment_typestring or null

Example: "percentage or fixed_amount"

subscriptions[].subscription_plan.price_adjustment_amountnumber or null

Example: 10

subscriptions[].subscription_plan.activeboolean or null

Default true

Example: true

subscriptions[].subscription_plan.company_defaultboolean or null

Default false

Example: false

subscriptions[].subscription_plan.created_atstring(date-time)required

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

subscriptions[].subscription_plan.updated_atstring(date-time)required

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

subscriptions[].subscription_plan.products_countinteger or null

Example: 10

subscriptions[].subscription_plan.subscribers_countinteger or null

Example: 10

subscriptions[].variantnull or objectrequired

One of:

null

subscriptions[].customerobject(Customer)required

subscriptions[].customer.idintegerrequired

subscriptions[].customer.account_idstring or null

subscriptions[].customer.first_namestring or null

subscriptions[].customer.last_namestring or null

subscriptions[].customer.full_namestringrequired

subscriptions[].customer.emailstring\A[a-zA-Z0-9.!\#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-...required

subscriptions[].customer.verified_emailboolean or null

Default false

subscriptions[].customer.phonestring or null

subscriptions[].customer.orders_countinteger or null

Default 0

subscriptions[].customer.created_atstring(date-time)required

subscriptions[].customer.display_total_spentstringrequired

subscriptions[].customer.metadataobjectrequired

Default "{}"

subscriptions[].customer.user_company_idinteger or null

subscriptions[].customer.external_idstring or null

subscriptions[].customer.last_order_idinteger or null

Example: 101

subscriptions[].customer.notesstring or null

Example: "This is a note"

subscriptions[].customer.activebooleanrequired

subscriptions[].customer.total_spentnumber or stringrequired

Example: 100

subscriptions[].customer.customer_notesArray of objects(CustomerNote)required

subscriptions[].customer.customer_notes[].idintegerrequired

subscriptions[].customer.customer_notes[].notestringrequired

subscriptions[].customer.customer_notes[].user_company_idinteger or null

subscriptions[].customer.customer_notes[].customer_idintegerrequired

subscriptions[].customer.customer_notes[].resource_idinteger or null

subscriptions[].customer.customer_notes[].resource_typestring or null

subscriptions[].customer.customer_notes[].created_atstring(date-time)required

subscriptions[].customer.default_addressobject or null(Address)

subscriptions[].customer.addressesArray of arraysrequired

subscriptions[].customer.is_repbooleanrequired

Example: true

subscriptions[].customer.is_discardedbooleanrequired

Example: false

subscriptions[].customer.payment_methodsArray of arraysrequired

metaobject

Response

application/json

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

Create a subscription

Request

Create a subscription

Bodyapplication/json

Subscription params. next_bill_date (YYYY-MM-DD) calculated internally if not provided.

subscriptionobjectrequired

subscription.subscription_plan_idintegerrequired

subscription.customer_idintegerrequired

subscription.variant_idintegerrequired

subscription.address_idintegerrequired

subscription.payment_method_idintegerrequired

subscription.order_item_idinteger

subscription.statusstring

subscription.disabledboolean

subscription.quantityinteger

subscription.metadataobject

subscription.notesstring

subscription.next_bill_datestring(date-time)

curl -i -X POST \
  https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/subscriptions \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "subscription": {
      "subscription_plan_id": 0,
      "customer_id": 0,
      "variant_id": 0,
      "address_id": 0,
      "payment_method_id": 0,
      "order_item_id": 0,
      "status": "string",
      "disabled": true,
      "quantity": 0,
      "metadata": {},
      "notes": "string",
      "next_bill_date": "2019-08-24T14:15:22Z"
    }
  }'

Responses

success

Bodyapplication/json

subscriptionobject(Commerce::Subscription)required

subscription.idintegerrequired

subscription.subscription_tokenstringrequired

Example: "sb_1234567890"

subscription.next_bill_datestring or nullrequired

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

subscription.last_bill_datestring or null(date)

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

subscription.next_ship_datestring or null(date)

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

subscription.last_ship_datestring or null(date)

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

subscription.statusstringrequired

Enum"pending""active""paused""past_due""cancelled""trial"

Example: "active"

subscription.disabledboolean or null

Default false

Example: false

subscription.quantityinteger>= 1required

Default 1

Example: 1

subscription.pricenumberrequired

Example: 100

subscription.original_pricenumberrequired

Example: 100

subscription.attemptsinteger or null

Default 0

Example: 1

subscription.last_failed_atstring or null(date-time)

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

subscription.next_retry_atstring or null(date-time)

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

subscription.skipped_countinteger or null

Default 0

Example: 1

subscription.max_skipsinteger or null

Example: 1

subscription.trial_ends_atstring or null(date-time)

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

subscription.cancelled_atstring or null(date-time)

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

subscription.created_atstring(date-time)required

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

subscription.updated_atstring(date-time)required

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

subscription.notesstring or null

Example: "This is a sample commerce subscription"

subscription.in_trialbooleanrequired

Example: false

subscription.subscription_planobject(Commerce::SubscriptionPlan)required

subscription.subscription_plan.idintegerrequired

subscription.subscription_plan.namestringrequired

Example: "Test Subscription Plan"

subscription.subscription_plan.billing_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription.subscription_plan.billing_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription.subscription_plan.billing_frequency_in_wordsstringrequired

Example: "2 Months"

subscription.subscription_plan.shipping_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription.subscription_plan.shipping_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription.subscription_plan.volume_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription.subscription_plan.volume_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription.subscription_plan.trial_periodinteger or null>= 1

Example: 1

subscription.subscription_plan.trial_period_unitstring or null

Possible values: day, week, month, year

Example: "day"

subscription.subscription_plan.split_volumebooleanrequired

Default false

Example: true

subscription.subscription_plan.allow_skippingboolean or null

Default true

Example: true

subscription.subscription_plan.max_skipsinteger or null>= 1

Example: 1

subscription.subscription_plan.price_adjustment_typestring or null

Example: "percentage or fixed_amount"

subscription.subscription_plan.price_adjustment_amountnumber or null

Example: 10

subscription.subscription_plan.activeboolean or null

Default true

Example: true

subscription.subscription_plan.company_defaultboolean or null

Default false

Example: false

subscription.subscription_plan.created_atstring(date-time)required

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

subscription.subscription_plan.updated_atstring(date-time)required

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

subscription.subscription_plan.products_countinteger or null

Example: 10

subscription.subscription_plan.subscribers_countinteger or null

Example: 10

subscription.variantnull or objectrequired

One of:

null

subscription.customerobject(Customer)required

subscription.customer.idintegerrequired

subscription.customer.account_idstring or null

subscription.customer.first_namestring or null

subscription.customer.last_namestring or null

subscription.customer.full_namestringrequired

subscription.customer.emailstring\A[a-zA-Z0-9.!\#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-...required

subscription.customer.verified_emailboolean or null

Default false

subscription.customer.phonestring or null

subscription.customer.orders_countinteger or null

Default 0

subscription.customer.created_atstring(date-time)required

subscription.customer.display_total_spentstringrequired

subscription.customer.metadataobjectrequired

Default "{}"

subscription.customer.user_company_idinteger or null

subscription.customer.external_idstring or null

subscription.customer.last_order_idinteger or null

Example: 101

subscription.customer.notesstring or null

Example: "This is a note"

subscription.customer.activebooleanrequired

subscription.customer.total_spentnumber or stringrequired

Example: 100

subscription.customer.customer_notesArray of objects(CustomerNote)required

subscription.customer.customer_notes[].idintegerrequired

subscription.customer.customer_notes[].notestringrequired

subscription.customer.customer_notes[].user_company_idinteger or null

subscription.customer.customer_notes[].customer_idintegerrequired

subscription.customer.customer_notes[].resource_idinteger or null

subscription.customer.customer_notes[].resource_typestring or null

subscription.customer.customer_notes[].created_atstring(date-time)required

subscription.customer.default_addressobject or null(Address)

subscription.customer.addressesArray of arraysrequired

subscription.customer.is_repbooleanrequired

Example: true

subscription.customer.is_discardedbooleanrequired

Example: false

subscription.customer.payment_methodsArray of arraysrequired

subscription.addressobject(Address)required

subscription.address.idintegerrequired

subscription.address.namestringrequired

Example: "John Doe"

subscription.address.address1stringrequired

Example: "123 Main St"

subscription.address.address2string or null

Example: "Apt 4B"

subscription.address.address3string or null

Example: "Building 5"

subscription.address.citystringrequired

Example: "New York"

subscription.address.statestringrequired

Example: "NY"

subscription.address.subdivision_codestring or null

Example: "NY"

subscription.address.postal_codestringrequired

Example: "10001"

subscription.address.country_codestring or null

Example: "US"

subscription.address.defaultboolean or null

Use this address by default when there are multiple addresses

Default false

Example: true

subscription.address.first_namestringrequired

Example: "John"

subscription.address.last_namestringrequired

Example: "Doe"

subscription.payment_methodobject(Commerce::PaymentMethod)required

subscription.payment_method.idintegerrequired

subscription.payment_method.sourcestringrequired

Enum"apple_pay""paypal""card""iap""bread""affirm""google_pay""klarna""droplet""citcon"

subscription.payment_method.created_atstring(date-time)required

subscription.payment_method.updated_atstring(date-time)required

subscription.payment_method.defaultbooleanrequired

subscription.payment_method.payment_typestringrequired

Example: "Credit Card"

subscription.payment_method.detailsobjectrequired

subscription.currencyobject(Currency)required

subscription.currency.idintegerrequired

subscription.currency.namestring or null

Example: "United States Dollar"

subscription.currency.codestringrequired

Example: "USD"

subscription.currency.ratenumber or string or null

Example: 1

subscription.currency.activeboolean or null

Default false

Example: true

subscription.currency.symbolstring or null

Example: "$"

subscription.countryobject(Country)required

subscription.country.idintegerrequired

subscription.country.namestringrequired

Example: "United States"

subscription.country.isostringrequired

2-letter country code (ISO 3166-1 alpha-2)

Example: "US"

subscription.companyobject(Company)required

subscription.company.idintegerrequired

subscription.company.namestringrequired

Example: "Acme, Inc."

subscription.subscription_skipsArray of objects(Commerce::SubscriptionSkip)required

subscription.subscription_skips[].idintegerrequired

subscription.subscription_skips[].skipped_datestring(date)required

Example: "2025-01-01T00:00:00Z"

subscription.subscription_skips[].reasonnull

Example: "Customer requested to skip next billing"

subscription.subscription_skips[].created_atstring(date-time)required

Example: "2025-01-01T00:00:00Z"

subscription.subscription_skips[].updated_atstring(date-time)required

Example: "2025-01-01T00:00:00Z"

subscription.ordersArray of objects(Commerce::Order)required

subscription.orders[].idintegerrequired

subscription.orders[].first_namestring or null

subscription.orders[].last_namestring or null

subscription.orders[].emailstring or null

subscription.orders[].phonestring or null

subscription.orders[].order_numberstring or null

subscription.orders[].statusstringrequired

Enum"awaiting_payment""awaiting_shipment""shipped""delivered""archived""cancelled""failed_payment""draft"

subscription.orders[].order_typestringrequired

Enum"requested""purchased""imported""abandoned"

subscription.orders[].amountnumber or string or null

Default "0.0"

subscription.orders[].notestring or null

subscription.orders[].currency_codestring or null

subscription.orders[].created_atstring(date-time)required

subscription.orders[].updated_atstring(date-time)required

subscription.orders[].metadataobject or null

Default "{}"

subscription.orders[].tokenstringrequired

subscription.orders[].refundable_amountstringrequired

subscription.orders[].shipping_methodobjectrequired

subscription.orders[].items_quantityintegerrequired

Example: 5

metaobject

Response

application/json

{
  "subscription": {
    "id": 0,
    "subscription_token": "sb_1234567890",
    "next_bill_date": "2025-03-10T00:00:00Z",
    "last_bill_date": "2025-03-10T00:00:00Z",
    "next_ship_date": "2025-03-10T00:00:00Z",
    "last_ship_date": "2025-03-10T00:00:00Z",
    "status": "active",
    "disabled": false,
    "quantity": 1,
    "price": 100,
    "original_price": 100,
    "attempts": 1,
    "last_failed_at": "2025-03-10T00:00:00Z",
    "next_retry_at": "2025-03-10T00:00:00Z",
    "skipped_count": 1,
    "max_skips": 1,
    "trial_ends_at": "2025-03-10T00:00:00Z",
    "cancelled_at": "2025-03-10T00:00:00Z",
    "created_at": "2025-03-10T00:00:00Z",
    "updated_at": "2025-03-10T00:00:00Z",
    "notes": "This is a sample commerce subscription",
    "in_trial": false,
    "subscription_plan": { … },
    "variant": {},
    "customer": { … },
    "address": { … },
    "payment_method": { … },
    "currency": { … },
    "country": { … },
    "company": { … },
    "subscription_skips": [ … ],
    "orders": [ … ]
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Show a subscription

Request

Show a subscription by token or ID, with optional shipping fee calculation

Path

tokenstringrequired

Query

customer_idinteger

curl -i -X GET \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/subscriptions/{token}?customer_id=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

success

Bodyapplication/json

subscriptionobject(Commerce::Subscription)required

subscription.idintegerrequired

subscription.next_orderobjectrequired

subscription.subscription_tokenstringrequired

Example: "sb_1234567890"

subscription.next_bill_datestring or nullrequired

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

subscription.last_bill_datestring or null(date)

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

subscription.next_ship_datestring or null(date)

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

subscription.last_ship_datestring or null(date)

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

subscription.statusstringrequired

Enum"pending""active""paused""past_due""cancelled""trial"

Example: "active"

subscription.disabledboolean or null

Default false

Example: false

subscription.quantityinteger>= 1required

Default 1

Example: 1

subscription.pricenumberrequired

Example: 100

subscription.original_pricenumberrequired

Example: 100

subscription.attemptsinteger or null

Default 0

Example: 1

subscription.last_failed_atstring or null(date-time)

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

subscription.next_retry_atstring or null(date-time)

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

subscription.skipped_countinteger or null

Default 0

Example: 1

subscription.max_skipsinteger or null

Example: 1

subscription.trial_ends_atstring or null(date-time)

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

subscription.cancelled_atstring or null(date-time)

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

subscription.created_atstring(date-time)required

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

subscription.updated_atstring(date-time)required

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

subscription.notesstring or null

Example: "This is a sample commerce subscription"

subscription.in_trialbooleanrequired

Example: false

subscription.subscription_planobject(Commerce::SubscriptionPlan)required

subscription.subscription_plan.idintegerrequired

subscription.subscription_plan.namestringrequired

Example: "Test Subscription Plan"

subscription.subscription_plan.billing_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription.subscription_plan.billing_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription.subscription_plan.billing_frequency_in_wordsstringrequired

Example: "2 Months"

subscription.subscription_plan.shipping_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription.subscription_plan.shipping_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription.subscription_plan.volume_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription.subscription_plan.volume_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription.subscription_plan.trial_periodinteger or null>= 1

Example: 1

subscription.subscription_plan.trial_period_unitstring or null

Possible values: day, week, month, year

Example: "day"

subscription.subscription_plan.split_volumebooleanrequired

Default false

Example: true

subscription.subscription_plan.allow_skippingboolean or null

Default true

Example: true

subscription.subscription_plan.max_skipsinteger or null>= 1

Example: 1

subscription.subscription_plan.price_adjustment_typestring or null

Example: "percentage or fixed_amount"

subscription.subscription_plan.price_adjustment_amountnumber or null

Example: 10

subscription.subscription_plan.activeboolean or null

Default true

Example: true

subscription.subscription_plan.company_defaultboolean or null

Default false

Example: false

subscription.subscription_plan.created_atstring(date-time)required

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

subscription.subscription_plan.updated_atstring(date-time)required

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

subscription.subscription_plan.products_countinteger or null

Example: 10

subscription.subscription_plan.subscribers_countinteger or null

Example: 10

subscription.variantnull or objectrequired

One of:

null

subscription.customerobject(Customer)required

subscription.customer.idintegerrequired

subscription.customer.account_idstring or null

subscription.customer.first_namestring or null

subscription.customer.last_namestring or null

subscription.customer.full_namestringrequired

subscription.customer.emailstring\A[a-zA-Z0-9.!\#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-...required

subscription.customer.verified_emailboolean or null

Default false

subscription.customer.phonestring or null

subscription.customer.orders_countinteger or null

Default 0

subscription.customer.created_atstring(date-time)required

subscription.customer.display_total_spentstringrequired

subscription.customer.metadataobjectrequired

Default "{}"

subscription.customer.user_company_idinteger or null

subscription.customer.external_idstring or null

subscription.customer.last_order_idinteger or null

Example: 101

subscription.customer.notesstring or null

Example: "This is a note"

subscription.customer.activebooleanrequired

subscription.customer.total_spentnumber or stringrequired

Example: 100

subscription.customer.customer_notesArray of objects(CustomerNote)required

subscription.customer.customer_notes[].idintegerrequired

subscription.customer.customer_notes[].notestringrequired

subscription.customer.customer_notes[].user_company_idinteger or null

subscription.customer.customer_notes[].customer_idintegerrequired

subscription.customer.customer_notes[].resource_idinteger or null

subscription.customer.customer_notes[].resource_typestring or null

subscription.customer.customer_notes[].created_atstring(date-time)required

subscription.customer.default_addressobject or null(Address)

subscription.customer.addressesArray of objects(Address)required

subscription.customer.addresses[].idintegerrequired

subscription.customer.addresses[].namestringrequired

Example: "John Doe"

subscription.customer.addresses[].address1stringrequired

Example: "123 Main St"

subscription.customer.addresses[].address2string or null

Example: "Apt 4B"

subscription.customer.addresses[].address3string or null

Example: "Building 5"

subscription.customer.addresses[].citystringrequired

Example: "New York"

subscription.customer.addresses[].statestringrequired

Example: "NY"

subscription.customer.addresses[].subdivision_codestring or null

Example: "NY"

subscription.customer.addresses[].postal_codestringrequired

Example: "10001"

subscription.customer.addresses[].country_codestring or null

Example: "US"

subscription.customer.addresses[].defaultboolean or null

Use this address by default when there are multiple addresses

Default false

Example: true

subscription.customer.addresses[].first_namestringrequired

Example: "John"

subscription.customer.addresses[].last_namestringrequired

Example: "Doe"

subscription.customer.is_repbooleanrequired

Example: true

subscription.customer.is_discardedbooleanrequired

Example: false

subscription.customer.active_subscriptions_countintegerrequired

Example: 10

subscription.customer.inactive_subscriptions_countintegerrequired

Example: 10

subscription.customer.metafieldsArray of objects(Metafield)required

subscription.customer.metafields[].idintegerrequired

subscription.customer.metafields[].namespacestring<= 20 characters\A[a-zA-Z0-9_]+\zrequired

A container for related metafields. Commonly used to group metafields by app or functionality.

Example: "custom"

subscription.customer.metafields[].keystring<= 30 characters\A[a-zA-Z0-9_]+\zrequired

The unique identifier for the metafield within its namespace. Must be unique per namespace and owner.

Example: "material"

subscription.customer.metafields[].valuestring or objectrequired

The actual data stored in the metafield. Type depends on value_type.

Example: "cotton"

subscription.customer.metafields[].value_typestringrequired

The data type that defines how the value should be interpreted and validated.

Example: "single_line_text_field"

subscription.customer.metafields[].descriptionstring or null

Optional human-readable description explaining the purpose of this metafield.

Example: "The primary material used in this product"

subscription.customer.metafields[].owner_typestringrequired

The type of resource that this metafield belongs to (polymorphic association).

Example: "Product"

subscription.customer.metafields[].owner_idintegerrequired

The ID of the specific resource that this metafield belongs to.

Example: 12345

subscription.customer.metafields[].created_atstring(date-time)required

Timestamp when the metafield was created.

Example: "2021-01-01T00:00:00Z"

subscription.customer.metafields[].updated_atstring(date-time)required

Timestamp when the metafield was last updated.

Example: "2021-01-01T00:00:00Z"

subscription.customer.metafields[].metafield_definitionobject or null(MetafieldDefinition)

subscription.customer.jwtstringrequired

subscription.addressobject(Address)required

subscription.address.idintegerrequired

subscription.address.namestringrequired

Example: "John Doe"

subscription.address.address1stringrequired

Example: "123 Main St"

subscription.address.address2string or null

Example: "Apt 4B"

subscription.address.address3string or null

Example: "Building 5"

subscription.address.citystringrequired

Example: "New York"

subscription.address.statestringrequired

Example: "NY"

subscription.address.subdivision_codestring or null

Example: "NY"

subscription.address.postal_codestringrequired

Example: "10001"

subscription.address.country_codestring or null

Example: "US"

subscription.address.defaultboolean or null

Use this address by default when there are multiple addresses

Default false

Example: true

subscription.address.first_namestringrequired

Example: "John"

subscription.address.last_namestringrequired

Example: "Doe"

subscription.payment_methodobject(Commerce::PaymentMethod)required

subscription.payment_method.idintegerrequired

subscription.payment_method.sourcestringrequired

Enum"apple_pay""paypal""card""iap""bread""affirm""google_pay""klarna""droplet""citcon"

subscription.payment_method.created_atstring(date-time)required

subscription.payment_method.updated_atstring(date-time)required

subscription.payment_method.defaultbooleanrequired

subscription.payment_method.payment_typestringrequired

Example: "Credit Card"

subscription.payment_method.detailsobjectrequired

subscription.currencyobject(Currency)required

subscription.currency.idintegerrequired

subscription.currency.namestring or null

Example: "United States Dollar"

subscription.currency.codestringrequired

Example: "USD"

subscription.currency.ratenumber or string or null

Example: 1

subscription.currency.activeboolean or null

Default false

Example: true

subscription.currency.symbolstring or null

Example: "$"

subscription.countryobject(Country)required

subscription.country.idintegerrequired

subscription.country.namestringrequired

Example: "United States"

subscription.country.isostringrequired

2-letter country code (ISO 3166-1 alpha-2)

Example: "US"

subscription.companyobject(Company)required

subscription.company.idintegerrequired

subscription.company.namestringrequired

Example: "Acme, Inc."

subscription.subscription_skipsArray of objects(Commerce::SubscriptionSkip)required

subscription.subscription_skips[].idintegerrequired

subscription.subscription_skips[].skipped_datestring(date)required

Example: "2025-01-01T00:00:00Z"

subscription.subscription_skips[].reasonnull

Example: "Customer requested to skip next billing"

subscription.subscription_skips[].created_atstring(date-time)required

Example: "2025-01-01T00:00:00Z"

subscription.subscription_skips[].updated_atstring(date-time)required

Example: "2025-01-01T00:00:00Z"

subscription.ordersArray of objects(Commerce::Order)required

subscription.orders[].idintegerrequired

subscription.orders[].first_namestring or null

subscription.orders[].last_namestring or null

subscription.orders[].emailstring or null

subscription.orders[].phonestring or null

subscription.orders[].order_numberstring or null

subscription.orders[].statusstringrequired

Enum"awaiting_payment""awaiting_shipment""shipped""delivered""archived""cancelled""failed_payment""draft"

subscription.orders[].order_typestringrequired

Enum"requested""purchased""imported""abandoned"

subscription.orders[].amountnumber or string or null

Default "0.0"

subscription.orders[].notestring or null

subscription.orders[].currency_codestring or null

subscription.orders[].created_atstring(date-time)required

subscription.orders[].updated_atstring(date-time)required

subscription.orders[].metadataobject or null

Default "{}"

subscription.orders[].tokenstringrequired

subscription.orders[].refundable_amountstringrequired

subscription.orders[].shipping_methodobjectrequired

subscription.orders[].items_quantityintegerrequired

Example: 5

subscription.shipping_feenumber or nullrequired

Example: [15.99,null]

subscription.shipping_fee_for_displaystring or nullrequired

Example: ["Free","$15.99",null]

metaobject

Response

application/json

{
  "subscription": {
    "id": 0,
    "next_order": {},
    "subscription_token": "sb_1234567890",
    "next_bill_date": "2025-03-10T00:00:00Z",
    "last_bill_date": "2025-03-10T00:00:00Z",
    "next_ship_date": "2025-03-10T00:00:00Z",
    "last_ship_date": "2025-03-10T00:00:00Z",
    "status": "active",
    "disabled": false,
    "quantity": 1,
    "price": 100,
    "original_price": 100,
    "attempts": 1,
    "last_failed_at": "2025-03-10T00:00:00Z",
    "next_retry_at": "2025-03-10T00:00:00Z",
    "skipped_count": 1,
    "max_skips": 1,
    "trial_ends_at": "2025-03-10T00:00:00Z",
    "cancelled_at": "2025-03-10T00:00:00Z",
    "created_at": "2025-03-10T00:00:00Z",
    "updated_at": "2025-03-10T00:00:00Z",
    "notes": "This is a sample commerce subscription",
    "in_trial": false,
    "subscription_plan": { … },
    "variant": {},
    "customer": { … },
    "address": { … },
    "payment_method": { … },
    "currency": { … },
    "country": { … },
    "company": { … },
    "subscription_skips": [ … ],
    "orders": [ … ],
    "shipping_fee": [ … ],
    "shipping_fee_for_display": [ … ]
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Update a subscription

Request

Update a subscription

Path

tokenstringrequired

Bodyapplication/json

Subscription params. next_bill_date (YYYY-MM-DD) calculated internally if not provided.

tokenstring

idinteger

subscriptionobjectrequired

subscription.subscription_plan_idintegerrequired

subscription.customer_idintegerrequired

subscription.variant_idintegerrequired

subscription.address_idintegerrequired

subscription.payment_method_idintegerrequired

subscription.order_item_idinteger

subscription.statusstring

subscription.disabledboolean

subscription.quantityinteger

subscription.metadataobject

subscription.notesstring

subscription.next_bill_datestring(date-time)

curl -i -X PUT \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/subscriptions/{token}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "token": "string",
    "id": 0,
    "subscription": {
      "subscription_plan_id": 0,
      "customer_id": 0,
      "variant_id": 0,
      "address_id": 0,
      "payment_method_id": 0,
      "order_item_id": 0,
      "status": "string",
      "disabled": true,
      "quantity": 0,
      "metadata": {},
      "notes": "string",
      "next_bill_date": "2019-08-24T14:15:22Z"
    }
  }'

Responses

success

Bodyapplication/json

subscriptionobject(Commerce::Subscription)required

subscription.idintegerrequired

subscription.subscription_tokenstringrequired

Example: "sb_1234567890"

subscription.next_bill_datestring or nullrequired

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

subscription.last_bill_datestring or null(date)

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

subscription.next_ship_datestring or null(date)

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

subscription.last_ship_datestring or null(date)

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

subscription.statusstringrequired

Enum"pending""active""paused""past_due""cancelled""trial"

Example: "active"

subscription.disabledboolean or null

Default false

Example: false

subscription.quantityinteger>= 1required

Default 1

Example: 1

subscription.pricenumberrequired

Example: 100

subscription.original_pricenumberrequired

Example: 100

subscription.attemptsinteger or null

Default 0

Example: 1

subscription.last_failed_atstring or null(date-time)

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

subscription.next_retry_atstring or null(date-time)

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

subscription.skipped_countinteger or null

Default 0

Example: 1

subscription.max_skipsinteger or null

Example: 1

subscription.trial_ends_atstring or null(date-time)

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

subscription.cancelled_atstring or null(date-time)

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

subscription.created_atstring(date-time)required

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

subscription.updated_atstring(date-time)required

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

subscription.notesstring or null

Example: "This is a sample commerce subscription"

subscription.in_trialbooleanrequired

Example: false

subscription.subscription_planobject(Commerce::SubscriptionPlan)required

subscription.subscription_plan.idintegerrequired

subscription.subscription_plan.namestringrequired

Example: "Test Subscription Plan"

subscription.subscription_plan.billing_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription.subscription_plan.billing_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription.subscription_plan.billing_frequency_in_wordsstringrequired

Example: "2 Months"

subscription.subscription_plan.shipping_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription.subscription_plan.shipping_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription.subscription_plan.volume_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription.subscription_plan.volume_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription.subscription_plan.trial_periodinteger or null>= 1

Example: 1

subscription.subscription_plan.trial_period_unitstring or null

Possible values: day, week, month, year

Example: "day"

subscription.subscription_plan.split_volumebooleanrequired

Default false

Example: true

subscription.subscription_plan.allow_skippingboolean or null

Default true

Example: true

subscription.subscription_plan.max_skipsinteger or null>= 1

Example: 1

subscription.subscription_plan.price_adjustment_typestring or null

Example: "percentage or fixed_amount"

subscription.subscription_plan.price_adjustment_amountnumber or null

Example: 10

subscription.subscription_plan.activeboolean or null

Default true

Example: true

subscription.subscription_plan.company_defaultboolean or null

Default false

Example: false

subscription.subscription_plan.created_atstring(date-time)required

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

subscription.subscription_plan.updated_atstring(date-time)required

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

subscription.subscription_plan.products_countinteger or null

Example: 10

subscription.subscription_plan.subscribers_countinteger or null

Example: 10

subscription.variantnull or objectrequired

One of:

null

subscription.customerobject(Customer)required

subscription.customer.idintegerrequired

subscription.customer.account_idstring or null

subscription.customer.first_namestring or null

subscription.customer.last_namestring or null

subscription.customer.full_namestringrequired

subscription.customer.emailstring\A[a-zA-Z0-9.!\#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-...required

subscription.customer.verified_emailboolean or null

Default false

subscription.customer.phonestring or null

subscription.customer.orders_countinteger or null

Default 0

subscription.customer.created_atstring(date-time)required

subscription.customer.display_total_spentstringrequired

subscription.customer.metadataobjectrequired

Default "{}"

subscription.customer.user_company_idinteger or null

subscription.customer.external_idstring or null

subscription.customer.last_order_idinteger or null

Example: 101

subscription.customer.notesstring or null

Example: "This is a note"

subscription.customer.activebooleanrequired

subscription.customer.total_spentnumber or stringrequired

Example: 100

subscription.customer.customer_notesArray of objects(CustomerNote)required

subscription.customer.customer_notes[].idintegerrequired

subscription.customer.customer_notes[].notestringrequired

subscription.customer.customer_notes[].user_company_idinteger or null

subscription.customer.customer_notes[].customer_idintegerrequired

subscription.customer.customer_notes[].resource_idinteger or null

subscription.customer.customer_notes[].resource_typestring or null

subscription.customer.customer_notes[].created_atstring(date-time)required

subscription.customer.default_addressobject or null(Address)

subscription.customer.addressesArray of arraysrequired

subscription.customer.is_repbooleanrequired

Example: true

subscription.customer.is_discardedbooleanrequired

Example: false

subscription.customer.payment_methodsArray of arraysrequired

subscription.addressobject(Address)required

subscription.address.idintegerrequired

subscription.address.namestringrequired

Example: "John Doe"

subscription.address.address1stringrequired

Example: "123 Main St"

subscription.address.address2string or null

Example: "Apt 4B"

subscription.address.address3string or null

Example: "Building 5"

subscription.address.citystringrequired

Example: "New York"

subscription.address.statestringrequired

Example: "NY"

subscription.address.subdivision_codestring or null

Example: "NY"

subscription.address.postal_codestringrequired

Example: "10001"

subscription.address.country_codestring or null

Example: "US"

subscription.address.defaultboolean or null

Use this address by default when there are multiple addresses

Default false

Example: true

subscription.address.first_namestringrequired

Example: "John"

subscription.address.last_namestringrequired

Example: "Doe"

subscription.payment_methodobject(Commerce::PaymentMethod)required

subscription.payment_method.idintegerrequired

subscription.payment_method.sourcestringrequired

Enum"apple_pay""paypal""card""iap""bread""affirm""google_pay""klarna""droplet""citcon"

subscription.payment_method.created_atstring(date-time)required

subscription.payment_method.updated_atstring(date-time)required

subscription.payment_method.defaultbooleanrequired

subscription.payment_method.payment_typestringrequired

Example: "Credit Card"

subscription.payment_method.detailsobjectrequired

subscription.currencyobject(Currency)required

subscription.currency.idintegerrequired

subscription.currency.namestring or null

Example: "United States Dollar"

subscription.currency.codestringrequired

Example: "USD"

subscription.currency.ratenumber or string or null

Example: 1

subscription.currency.activeboolean or null

Default false

Example: true

subscription.currency.symbolstring or null

Example: "$"

subscription.countryobject(Country)required

subscription.country.idintegerrequired

subscription.country.namestringrequired

Example: "United States"

subscription.country.isostringrequired

2-letter country code (ISO 3166-1 alpha-2)

Example: "US"

subscription.companyobject(Company)required

subscription.company.idintegerrequired

subscription.company.namestringrequired

Example: "Acme, Inc."

subscription.subscription_skipsArray of objects(Commerce::SubscriptionSkip)required

subscription.subscription_skips[].idintegerrequired

subscription.subscription_skips[].skipped_datestring(date)required

Example: "2025-01-01T00:00:00Z"

subscription.subscription_skips[].reasonnull

Example: "Customer requested to skip next billing"

subscription.subscription_skips[].created_atstring(date-time)required

Example: "2025-01-01T00:00:00Z"

subscription.subscription_skips[].updated_atstring(date-time)required

Example: "2025-01-01T00:00:00Z"

subscription.ordersArray of objects(Commerce::Order)required

subscription.orders[].idintegerrequired

subscription.orders[].first_namestring or null

subscription.orders[].last_namestring or null

subscription.orders[].emailstring or null

subscription.orders[].phonestring or null

subscription.orders[].order_numberstring or null

subscription.orders[].statusstringrequired

Enum"awaiting_payment""awaiting_shipment""shipped""delivered""archived""cancelled""failed_payment""draft"

subscription.orders[].order_typestringrequired

Enum"requested""purchased""imported""abandoned"

subscription.orders[].amountnumber or string or null

Default "0.0"

subscription.orders[].notestring or null

subscription.orders[].currency_codestring or null

subscription.orders[].created_atstring(date-time)required

subscription.orders[].updated_atstring(date-time)required

subscription.orders[].metadataobject or null

Default "{}"

subscription.orders[].tokenstringrequired

subscription.orders[].refundable_amountstringrequired

subscription.orders[].shipping_methodobjectrequired

subscription.orders[].items_quantityintegerrequired

Example: 5

metaobject

Response

application/json

{
  "subscription": {
    "id": 0,
    "subscription_token": "sb_1234567890",
    "next_bill_date": "2025-03-10T00:00:00Z",
    "last_bill_date": "2025-03-10T00:00:00Z",
    "next_ship_date": "2025-03-10T00:00:00Z",
    "last_ship_date": "2025-03-10T00:00:00Z",
    "status": "active",
    "disabled": false,
    "quantity": 1,
    "price": 100,
    "original_price": 100,
    "attempts": 1,
    "last_failed_at": "2025-03-10T00:00:00Z",
    "next_retry_at": "2025-03-10T00:00:00Z",
    "skipped_count": 1,
    "max_skips": 1,
    "trial_ends_at": "2025-03-10T00:00:00Z",
    "cancelled_at": "2025-03-10T00:00:00Z",
    "created_at": "2025-03-10T00:00:00Z",
    "updated_at": "2025-03-10T00:00:00Z",
    "notes": "This is a sample commerce subscription",
    "in_trial": false,
    "subscription_plan": { … },
    "variant": {},
    "customer": { … },
    "address": { … },
    "payment_method": { … },
    "currency": { … },
    "country": { … },
    "company": { … },
    "subscription_skips": [ … ],
    "orders": [ … ]
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Pause a subscription

Request

Pause a subscription with a future resume date

Path

tokenstringrequired

Query

next_bill_datestring(date)

Resume date for paused subscription. Omit for indefinite pause.

curl -i -X POST \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/subscriptions/{token}/pause?next_bill_date=2019-08-24' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

success

Bodyapplication/json

subscriptionobject(Commerce::Subscription)required

subscription.idintegerrequired

subscription.subscription_tokenstringrequired

Example: "sb_1234567890"

subscription.next_bill_datestring or nullrequired

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

subscription.last_bill_datestring or null(date)

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

subscription.next_ship_datestring or null(date)

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

subscription.last_ship_datestring or null(date)

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

subscription.statusstringrequired

Enum"pending""active""paused""past_due""cancelled""trial"

Example: "active"

subscription.disabledboolean or null

Default false

Example: false

subscription.quantityinteger>= 1required

Default 1

Example: 1

subscription.pricenumberrequired

Example: 100

subscription.original_pricenumberrequired

Example: 100

subscription.attemptsinteger or null

Default 0

Example: 1

subscription.last_failed_atstring or null(date-time)

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

subscription.next_retry_atstring or null(date-time)

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

subscription.skipped_countinteger or null

Default 0

Example: 1

subscription.max_skipsinteger or null

Example: 1

subscription.trial_ends_atstring or null(date-time)

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

subscription.cancelled_atstring or null(date-time)

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

subscription.created_atstring(date-time)required

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

subscription.updated_atstring(date-time)required

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

subscription.notesstring or null

Example: "This is a sample commerce subscription"

subscription.in_trialbooleanrequired

Example: false

subscription.subscription_planobject(Commerce::SubscriptionPlan)required

subscription.subscription_plan.idintegerrequired

subscription.subscription_plan.namestringrequired

Example: "Test Subscription Plan"

subscription.subscription_plan.billing_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription.subscription_plan.billing_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription.subscription_plan.billing_frequency_in_wordsstringrequired

Example: "2 Months"

subscription.subscription_plan.shipping_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription.subscription_plan.shipping_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription.subscription_plan.volume_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription.subscription_plan.volume_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription.subscription_plan.trial_periodinteger or null>= 1

Example: 1

subscription.subscription_plan.trial_period_unitstring or null

Possible values: day, week, month, year

Example: "day"

subscription.subscription_plan.split_volumebooleanrequired

Default false

Example: true

subscription.subscription_plan.allow_skippingboolean or null

Default true

Example: true

subscription.subscription_plan.max_skipsinteger or null>= 1

Example: 1

subscription.subscription_plan.price_adjustment_typestring or null

Example: "percentage or fixed_amount"

subscription.subscription_plan.price_adjustment_amountnumber or null

Example: 10

subscription.subscription_plan.activeboolean or null

Default true

Example: true

subscription.subscription_plan.company_defaultboolean or null

Default false

Example: false

subscription.subscription_plan.created_atstring(date-time)required

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

subscription.subscription_plan.updated_atstring(date-time)required

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

subscription.subscription_plan.products_countinteger or null

Example: 10

subscription.subscription_plan.subscribers_countinteger or null

Example: 10

subscription.variantnull or objectrequired

One of:

null

subscription.customerobject(Customer)required

subscription.customer.idintegerrequired

subscription.customer.account_idstring or null

subscription.customer.first_namestring or null

subscription.customer.last_namestring or null

subscription.customer.full_namestringrequired

subscription.customer.emailstring\A[a-zA-Z0-9.!\#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-...required

subscription.customer.verified_emailboolean or null

Default false

subscription.customer.phonestring or null

subscription.customer.orders_countinteger or null

Default 0

subscription.customer.created_atstring(date-time)required

subscription.customer.display_total_spentstringrequired

subscription.customer.metadataobjectrequired

Default "{}"

subscription.customer.user_company_idinteger or null

subscription.customer.external_idstring or null

subscription.customer.last_order_idinteger or null

Example: 101

subscription.customer.notesstring or null

Example: "This is a note"

subscription.customer.activebooleanrequired

subscription.customer.total_spentnumber or stringrequired

Example: 100

subscription.customer.customer_notesArray of objects(CustomerNote)required

subscription.customer.customer_notes[].idintegerrequired

subscription.customer.customer_notes[].notestringrequired

subscription.customer.customer_notes[].user_company_idinteger or null

subscription.customer.customer_notes[].customer_idintegerrequired

subscription.customer.customer_notes[].resource_idinteger or null

subscription.customer.customer_notes[].resource_typestring or null

subscription.customer.customer_notes[].created_atstring(date-time)required

subscription.customer.default_addressobject or null(Address)

subscription.customer.addressesArray of arraysrequired

subscription.customer.is_repbooleanrequired

Example: true

subscription.customer.is_discardedbooleanrequired

Example: false

subscription.customer.payment_methodsArray of arraysrequired

subscription.addressobject(Address)required

subscription.address.idintegerrequired

subscription.address.namestringrequired

Example: "John Doe"

subscription.address.address1stringrequired

Example: "123 Main St"

subscription.address.address2string or null

Example: "Apt 4B"

subscription.address.address3string or null

Example: "Building 5"

subscription.address.citystringrequired

Example: "New York"

subscription.address.statestringrequired

Example: "NY"

subscription.address.subdivision_codestring or null

Example: "NY"

subscription.address.postal_codestringrequired

Example: "10001"

subscription.address.country_codestring or null

Example: "US"

subscription.address.defaultboolean or null

Use this address by default when there are multiple addresses

Default false

Example: true

subscription.address.first_namestringrequired

Example: "John"

subscription.address.last_namestringrequired

Example: "Doe"

subscription.payment_methodobject(Commerce::PaymentMethod)required

subscription.payment_method.idintegerrequired

subscription.payment_method.sourcestringrequired

Enum"apple_pay""paypal""card""iap""bread""affirm""google_pay""klarna""droplet""citcon"

subscription.payment_method.created_atstring(date-time)required

subscription.payment_method.updated_atstring(date-time)required

subscription.payment_method.defaultbooleanrequired

subscription.payment_method.payment_typestringrequired

Example: "Credit Card"

subscription.payment_method.detailsobjectrequired

subscription.currencyobject(Currency)required

subscription.currency.idintegerrequired

subscription.currency.namestring or null

Example: "United States Dollar"

subscription.currency.codestringrequired

Example: "USD"

subscription.currency.ratenumber or string or null

Example: 1

subscription.currency.activeboolean or null

Default false

Example: true

subscription.currency.symbolstring or null

Example: "$"

subscription.countryobject(Country)required

subscription.country.idintegerrequired

subscription.country.namestringrequired

Example: "United States"

subscription.country.isostringrequired

2-letter country code (ISO 3166-1 alpha-2)

Example: "US"

subscription.companyobject(Company)required

subscription.company.idintegerrequired

subscription.company.namestringrequired

Example: "Acme, Inc."

subscription.subscription_skipsArray of objects(Commerce::SubscriptionSkip)required

subscription.subscription_skips[].idintegerrequired

subscription.subscription_skips[].skipped_datestring(date)required

Example: "2025-01-01T00:00:00Z"

subscription.subscription_skips[].reasonnull

Example: "Customer requested to skip next billing"

subscription.subscription_skips[].created_atstring(date-time)required

Example: "2025-01-01T00:00:00Z"

subscription.subscription_skips[].updated_atstring(date-time)required

Example: "2025-01-01T00:00:00Z"

subscription.ordersArray of objects(Commerce::Order)required

subscription.orders[].idintegerrequired

subscription.orders[].first_namestring or null

subscription.orders[].last_namestring or null

subscription.orders[].emailstring or null

subscription.orders[].phonestring or null

subscription.orders[].order_numberstring or null

subscription.orders[].statusstringrequired

Enum"awaiting_payment""awaiting_shipment""shipped""delivered""archived""cancelled""failed_payment""draft"

subscription.orders[].order_typestringrequired

Enum"requested""purchased""imported""abandoned"

subscription.orders[].amountnumber or string or null

Default "0.0"

subscription.orders[].notestring or null

subscription.orders[].currency_codestring or null

subscription.orders[].created_atstring(date-time)required

subscription.orders[].updated_atstring(date-time)required

subscription.orders[].metadataobject or null

Default "{}"

subscription.orders[].tokenstringrequired

subscription.orders[].refundable_amountstringrequired

subscription.orders[].shipping_methodobjectrequired

subscription.orders[].items_quantityintegerrequired

Example: 5

metaobject

Response

application/json

{
  "subscription": {
    "id": 0,
    "subscription_token": "sb_1234567890",
    "next_bill_date": "2025-03-10T00:00:00Z",
    "last_bill_date": "2025-03-10T00:00:00Z",
    "next_ship_date": "2025-03-10T00:00:00Z",
    "last_ship_date": "2025-03-10T00:00:00Z",
    "status": "active",
    "disabled": false,
    "quantity": 1,
    "price": 100,
    "original_price": 100,
    "attempts": 1,
    "last_failed_at": "2025-03-10T00:00:00Z",
    "next_retry_at": "2025-03-10T00:00:00Z",
    "skipped_count": 1,
    "max_skips": 1,
    "trial_ends_at": "2025-03-10T00:00:00Z",
    "cancelled_at": "2025-03-10T00:00:00Z",
    "created_at": "2025-03-10T00:00:00Z",
    "updated_at": "2025-03-10T00:00:00Z",
    "notes": "This is a sample commerce subscription",
    "in_trial": false,
    "subscription_plan": { … },
    "variant": {},
    "customer": { … },
    "address": { … },
    "payment_method": { … },
    "currency": { … },
    "country": { … },
    "company": { … },
    "subscription_skips": [ … ],
    "orders": [ … ]
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Resume a paused subscription

Request

Resume a previously paused subscription

Path

tokenstringrequired

Query

next_bill_datestring(date)

curl -i -X POST \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/subscriptions/{token}/resume?next_bill_date=2019-08-24' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

success

Bodyapplication/json

subscriptionobject(Commerce::Subscription)required

subscription.idintegerrequired

subscription.subscription_tokenstringrequired

Example: "sb_1234567890"

subscription.next_bill_datestring or nullrequired

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

subscription.last_bill_datestring or null(date)

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

subscription.next_ship_datestring or null(date)

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

subscription.last_ship_datestring or null(date)

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

subscription.statusstringrequired

Enum"pending""active""paused""past_due""cancelled""trial"

Example: "active"

subscription.disabledboolean or null

Default false

Example: false

subscription.quantityinteger>= 1required

Default 1

Example: 1

subscription.pricenumberrequired

Example: 100

subscription.original_pricenumberrequired

Example: 100

subscription.attemptsinteger or null

Default 0

Example: 1

subscription.last_failed_atstring or null(date-time)

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

subscription.next_retry_atstring or null(date-time)

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

subscription.skipped_countinteger or null

Default 0

Example: 1

subscription.max_skipsinteger or null

Example: 1

subscription.trial_ends_atstring or null(date-time)

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

subscription.cancelled_atstring or null(date-time)

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

subscription.created_atstring(date-time)required

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

subscription.updated_atstring(date-time)required

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

subscription.notesstring or null

Example: "This is a sample commerce subscription"

subscription.in_trialbooleanrequired

Example: false

subscription.subscription_planobject(Commerce::SubscriptionPlan)required

subscription.subscription_plan.idintegerrequired

subscription.subscription_plan.namestringrequired

Example: "Test Subscription Plan"

subscription.subscription_plan.billing_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription.subscription_plan.billing_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription.subscription_plan.billing_frequency_in_wordsstringrequired

Example: "2 Months"

subscription.subscription_plan.shipping_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription.subscription_plan.shipping_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription.subscription_plan.volume_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription.subscription_plan.volume_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription.subscription_plan.trial_periodinteger or null>= 1

Example: 1

subscription.subscription_plan.trial_period_unitstring or null

Possible values: day, week, month, year

Example: "day"

subscription.subscription_plan.split_volumebooleanrequired

Default false

Example: true

subscription.subscription_plan.allow_skippingboolean or null

Default true

Example: true

subscription.subscription_plan.max_skipsinteger or null>= 1

Example: 1

subscription.subscription_plan.price_adjustment_typestring or null

Example: "percentage or fixed_amount"

subscription.subscription_plan.price_adjustment_amountnumber or null

Example: 10

subscription.subscription_plan.activeboolean or null

Default true

Example: true

subscription.subscription_plan.company_defaultboolean or null

Default false

Example: false

subscription.subscription_plan.created_atstring(date-time)required

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

subscription.subscription_plan.updated_atstring(date-time)required

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

subscription.subscription_plan.products_countinteger or null

Example: 10

subscription.subscription_plan.subscribers_countinteger or null

Example: 10

subscription.variantnull or objectrequired

One of:

null

subscription.customerobject(Customer)required

subscription.customer.idintegerrequired

subscription.customer.account_idstring or null

subscription.customer.first_namestring or null

subscription.customer.last_namestring or null

subscription.customer.full_namestringrequired

subscription.customer.emailstring\A[a-zA-Z0-9.!\#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-...required

subscription.customer.verified_emailboolean or null

Default false

subscription.customer.phonestring or null

subscription.customer.orders_countinteger or null

Default 0

subscription.customer.created_atstring(date-time)required

subscription.customer.display_total_spentstringrequired

subscription.customer.metadataobjectrequired

Default "{}"

subscription.customer.user_company_idinteger or null

subscription.customer.external_idstring or null

subscription.customer.last_order_idinteger or null

Example: 101

subscription.customer.notesstring or null

Example: "This is a note"

subscription.customer.activebooleanrequired

subscription.customer.total_spentnumber or stringrequired

Example: 100

subscription.customer.customer_notesArray of objects(CustomerNote)required

subscription.customer.customer_notes[].idintegerrequired

subscription.customer.customer_notes[].notestringrequired

subscription.customer.customer_notes[].user_company_idinteger or null

subscription.customer.customer_notes[].customer_idintegerrequired

subscription.customer.customer_notes[].resource_idinteger or null

subscription.customer.customer_notes[].resource_typestring or null

subscription.customer.customer_notes[].created_atstring(date-time)required

subscription.customer.default_addressobject or null(Address)

subscription.customer.addressesArray of arraysrequired

subscription.customer.is_repbooleanrequired

Example: true

subscription.customer.is_discardedbooleanrequired

Example: false

subscription.customer.payment_methodsArray of arraysrequired

subscription.addressobject(Address)required

subscription.address.idintegerrequired

subscription.address.namestringrequired

Example: "John Doe"

subscription.address.address1stringrequired

Example: "123 Main St"

subscription.address.address2string or null

Example: "Apt 4B"

subscription.address.address3string or null

Example: "Building 5"

subscription.address.citystringrequired

Example: "New York"

subscription.address.statestringrequired

Example: "NY"

subscription.address.subdivision_codestring or null

Example: "NY"

subscription.address.postal_codestringrequired

Example: "10001"

subscription.address.country_codestring or null

Example: "US"

subscription.address.defaultboolean or null

Use this address by default when there are multiple addresses

Default false

Example: true

subscription.address.first_namestringrequired

Example: "John"

subscription.address.last_namestringrequired

Example: "Doe"

subscription.payment_methodobject(Commerce::PaymentMethod)required

subscription.payment_method.idintegerrequired

subscription.payment_method.sourcestringrequired

Enum"apple_pay""paypal""card""iap""bread""affirm""google_pay""klarna""droplet""citcon"

subscription.payment_method.created_atstring(date-time)required

subscription.payment_method.updated_atstring(date-time)required

subscription.payment_method.defaultbooleanrequired

subscription.payment_method.payment_typestringrequired

Example: "Credit Card"

subscription.payment_method.detailsobjectrequired

subscription.currencyobject(Currency)required

subscription.currency.idintegerrequired

subscription.currency.namestring or null

Example: "United States Dollar"

subscription.currency.codestringrequired

Example: "USD"

subscription.currency.ratenumber or string or null

Example: 1

subscription.currency.activeboolean or null

Default false

Example: true

subscription.currency.symbolstring or null

Example: "$"

subscription.countryobject(Country)required

subscription.country.idintegerrequired

subscription.country.namestringrequired

Example: "United States"

subscription.country.isostringrequired

2-letter country code (ISO 3166-1 alpha-2)

Example: "US"

subscription.companyobject(Company)required

subscription.company.idintegerrequired

subscription.company.namestringrequired

Example: "Acme, Inc."

subscription.subscription_skipsArray of objects(Commerce::SubscriptionSkip)required

subscription.subscription_skips[].idintegerrequired

subscription.subscription_skips[].skipped_datestring(date)required

Example: "2025-01-01T00:00:00Z"

subscription.subscription_skips[].reasonnull

Example: "Customer requested to skip next billing"

subscription.subscription_skips[].created_atstring(date-time)required

Example: "2025-01-01T00:00:00Z"

subscription.subscription_skips[].updated_atstring(date-time)required

Example: "2025-01-01T00:00:00Z"

subscription.ordersArray of objects(Commerce::Order)required

subscription.orders[].idintegerrequired

subscription.orders[].first_namestring or null

subscription.orders[].last_namestring or null

subscription.orders[].emailstring or null

subscription.orders[].phonestring or null

subscription.orders[].order_numberstring or null

subscription.orders[].statusstringrequired

Enum"awaiting_payment""awaiting_shipment""shipped""delivered""archived""cancelled""failed_payment""draft"

subscription.orders[].order_typestringrequired

Enum"requested""purchased""imported""abandoned"

subscription.orders[].amountnumber or string or null

Default "0.0"

subscription.orders[].notestring or null

subscription.orders[].currency_codestring or null

subscription.orders[].created_atstring(date-time)required

subscription.orders[].updated_atstring(date-time)required

subscription.orders[].metadataobject or null

Default "{}"

subscription.orders[].tokenstringrequired

subscription.orders[].refundable_amountstringrequired

subscription.orders[].shipping_methodobjectrequired

subscription.orders[].items_quantityintegerrequired

Example: 5

metaobject

Response

application/json

{
  "subscription": {
    "id": 0,
    "subscription_token": "sb_1234567890",
    "next_bill_date": "2025-03-10T00:00:00Z",
    "last_bill_date": "2025-03-10T00:00:00Z",
    "next_ship_date": "2025-03-10T00:00:00Z",
    "last_ship_date": "2025-03-10T00:00:00Z",
    "status": "active",
    "disabled": false,
    "quantity": 1,
    "price": 100,
    "original_price": 100,
    "attempts": 1,
    "last_failed_at": "2025-03-10T00:00:00Z",
    "next_retry_at": "2025-03-10T00:00:00Z",
    "skipped_count": 1,
    "max_skips": 1,
    "trial_ends_at": "2025-03-10T00:00:00Z",
    "cancelled_at": "2025-03-10T00:00:00Z",
    "created_at": "2025-03-10T00:00:00Z",
    "updated_at": "2025-03-10T00:00:00Z",
    "notes": "This is a sample commerce subscription",
    "in_trial": false,
    "subscription_plan": { … },
    "variant": {},
    "customer": { … },
    "address": { … },
    "payment_method": { … },
    "currency": { … },
    "country": { … },
    "company": { … },
    "subscription_skips": [ … ],
    "orders": [ … ]
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Cancel a subscription

Request

Cancel a subscription

Path

tokenstringrequired

curl -i -X POST \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/subscriptions/{token}/cancel' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

success

Bodyapplication/json

subscriptionobject(Commerce::Subscription)required

subscription.idintegerrequired

subscription.subscription_tokenstringrequired

Example: "sb_1234567890"

subscription.next_bill_datestring or nullrequired

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

subscription.last_bill_datestring or null(date)

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

subscription.next_ship_datestring or null(date)

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

subscription.last_ship_datestring or null(date)

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

subscription.statusstringrequired

Enum"pending""active""paused""past_due""cancelled""trial"

Example: "active"

subscription.disabledboolean or null

Default false

Example: false

subscription.quantityinteger>= 1required

Default 1

Example: 1

subscription.pricenumberrequired

Example: 100

subscription.original_pricenumberrequired

Example: 100

subscription.attemptsinteger or null

Default 0

Example: 1

subscription.last_failed_atstring or null(date-time)

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

subscription.next_retry_atstring or null(date-time)

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

subscription.skipped_countinteger or null

Default 0

Example: 1

subscription.max_skipsinteger or null

Example: 1

subscription.trial_ends_atstring or null(date-time)

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

subscription.cancelled_atstring or null(date-time)

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

subscription.created_atstring(date-time)required

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

subscription.updated_atstring(date-time)required

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

subscription.notesstring or null

Example: "This is a sample commerce subscription"

subscription.in_trialbooleanrequired

Example: false

subscription.subscription_planobject(Commerce::SubscriptionPlan)required

subscription.subscription_plan.idintegerrequired

subscription.subscription_plan.namestringrequired

Example: "Test Subscription Plan"

subscription.subscription_plan.billing_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription.subscription_plan.billing_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription.subscription_plan.billing_frequency_in_wordsstringrequired

Example: "2 Months"

subscription.subscription_plan.shipping_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription.subscription_plan.shipping_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription.subscription_plan.volume_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription.subscription_plan.volume_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription.subscription_plan.trial_periodinteger or null>= 1

Example: 1

subscription.subscription_plan.trial_period_unitstring or null

Possible values: day, week, month, year

Example: "day"

subscription.subscription_plan.split_volumebooleanrequired

Default false

Example: true

subscription.subscription_plan.allow_skippingboolean or null

Default true

Example: true

subscription.subscription_plan.max_skipsinteger or null>= 1

Example: 1

subscription.subscription_plan.price_adjustment_typestring or null

Example: "percentage or fixed_amount"

subscription.subscription_plan.price_adjustment_amountnumber or null

Example: 10

subscription.subscription_plan.activeboolean or null

Default true

Example: true

subscription.subscription_plan.company_defaultboolean or null

Default false

Example: false

subscription.subscription_plan.created_atstring(date-time)required

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

subscription.subscription_plan.updated_atstring(date-time)required

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

subscription.subscription_plan.products_countinteger or null

Example: 10

subscription.subscription_plan.subscribers_countinteger or null

Example: 10

subscription.variantnull or objectrequired

One of:

null

subscription.customerobject(Customer)required

subscription.customer.idintegerrequired

subscription.customer.account_idstring or null

subscription.customer.first_namestring or null

subscription.customer.last_namestring or null

subscription.customer.full_namestringrequired

subscription.customer.emailstring\A[a-zA-Z0-9.!\#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-...required

subscription.customer.verified_emailboolean or null

Default false

subscription.customer.phonestring or null

subscription.customer.orders_countinteger or null

Default 0

subscription.customer.created_atstring(date-time)required

subscription.customer.display_total_spentstringrequired

subscription.customer.metadataobjectrequired

Default "{}"

subscription.customer.user_company_idinteger or null

subscription.customer.external_idstring or null

subscription.customer.last_order_idinteger or null

Example: 101

subscription.customer.notesstring or null

Example: "This is a note"

subscription.customer.activebooleanrequired

subscription.customer.total_spentnumber or stringrequired

Example: 100

subscription.customer.customer_notesArray of objects(CustomerNote)required

subscription.customer.customer_notes[].idintegerrequired

subscription.customer.customer_notes[].notestringrequired

subscription.customer.customer_notes[].user_company_idinteger or null

subscription.customer.customer_notes[].customer_idintegerrequired

subscription.customer.customer_notes[].resource_idinteger or null

subscription.customer.customer_notes[].resource_typestring or null

subscription.customer.customer_notes[].created_atstring(date-time)required

subscription.customer.default_addressobject or null(Address)

subscription.customer.addressesArray of arraysrequired

subscription.customer.is_repbooleanrequired

Example: true

subscription.customer.is_discardedbooleanrequired

Example: false

subscription.customer.payment_methodsArray of arraysrequired

subscription.addressobject(Address)required

subscription.address.idintegerrequired

subscription.address.namestringrequired

Example: "John Doe"

subscription.address.address1stringrequired

Example: "123 Main St"

subscription.address.address2string or null

Example: "Apt 4B"

subscription.address.address3string or null

Example: "Building 5"

subscription.address.citystringrequired

Example: "New York"

subscription.address.statestringrequired

Example: "NY"

subscription.address.subdivision_codestring or null

Example: "NY"

subscription.address.postal_codestringrequired

Example: "10001"

subscription.address.country_codestring or null

Example: "US"

subscription.address.defaultboolean or null

Use this address by default when there are multiple addresses

Default false

Example: true

subscription.address.first_namestringrequired

Example: "John"

subscription.address.last_namestringrequired

Example: "Doe"

subscription.payment_methodobject(Commerce::PaymentMethod)required

subscription.payment_method.idintegerrequired

subscription.payment_method.sourcestringrequired

Enum"apple_pay""paypal""card""iap""bread""affirm""google_pay""klarna""droplet""citcon"

subscription.payment_method.created_atstring(date-time)required

subscription.payment_method.updated_atstring(date-time)required

subscription.payment_method.defaultbooleanrequired

subscription.payment_method.payment_typestringrequired

Example: "Credit Card"

subscription.payment_method.detailsobjectrequired

subscription.currencyobject(Currency)required

subscription.currency.idintegerrequired

subscription.currency.namestring or null

Example: "United States Dollar"

subscription.currency.codestringrequired

Example: "USD"

subscription.currency.ratenumber or string or null

Example: 1

subscription.currency.activeboolean or null

Default false

Example: true

subscription.currency.symbolstring or null

Example: "$"

subscription.countryobject(Country)required

subscription.country.idintegerrequired

subscription.country.namestringrequired

Example: "United States"

subscription.country.isostringrequired

2-letter country code (ISO 3166-1 alpha-2)

Example: "US"

subscription.companyobject(Company)required

subscription.company.idintegerrequired

subscription.company.namestringrequired

Example: "Acme, Inc."

subscription.subscription_skipsArray of objects(Commerce::SubscriptionSkip)required

subscription.subscription_skips[].idintegerrequired

subscription.subscription_skips[].skipped_datestring(date)required

Example: "2025-01-01T00:00:00Z"

subscription.subscription_skips[].reasonnull

Example: "Customer requested to skip next billing"

subscription.subscription_skips[].created_atstring(date-time)required

Example: "2025-01-01T00:00:00Z"

subscription.subscription_skips[].updated_atstring(date-time)required

Example: "2025-01-01T00:00:00Z"

subscription.ordersArray of objects(Commerce::Order)required

subscription.orders[].idintegerrequired

subscription.orders[].first_namestring or null

subscription.orders[].last_namestring or null

subscription.orders[].emailstring or null

subscription.orders[].phonestring or null

subscription.orders[].order_numberstring or null

subscription.orders[].statusstringrequired

Enum"awaiting_payment""awaiting_shipment""shipped""delivered""archived""cancelled""failed_payment""draft"

subscription.orders[].order_typestringrequired

Enum"requested""purchased""imported""abandoned"

subscription.orders[].amountnumber or string or null

Default "0.0"

subscription.orders[].notestring or null

subscription.orders[].currency_codestring or null

subscription.orders[].created_atstring(date-time)required

subscription.orders[].updated_atstring(date-time)required

subscription.orders[].metadataobject or null

Default "{}"

subscription.orders[].tokenstringrequired

subscription.orders[].refundable_amountstringrequired

subscription.orders[].shipping_methodobjectrequired

subscription.orders[].items_quantityintegerrequired

Example: 5

metaobject

Response

application/json

{
  "subscription": {
    "id": 0,
    "subscription_token": "sb_1234567890",
    "next_bill_date": "2025-03-10T00:00:00Z",
    "last_bill_date": "2025-03-10T00:00:00Z",
    "next_ship_date": "2025-03-10T00:00:00Z",
    "last_ship_date": "2025-03-10T00:00:00Z",
    "status": "active",
    "disabled": false,
    "quantity": 1,
    "price": 100,
    "original_price": 100,
    "attempts": 1,
    "last_failed_at": "2025-03-10T00:00:00Z",
    "next_retry_at": "2025-03-10T00:00:00Z",
    "skipped_count": 1,
    "max_skips": 1,
    "trial_ends_at": "2025-03-10T00:00:00Z",
    "cancelled_at": "2025-03-10T00:00:00Z",
    "created_at": "2025-03-10T00:00:00Z",
    "updated_at": "2025-03-10T00:00:00Z",
    "notes": "This is a sample commerce subscription",
    "in_trial": false,
    "subscription_plan": { … },
    "variant": {},
    "customer": { … },
    "address": { … },
    "payment_method": { … },
    "currency": { … },
    "country": { … },
    "company": { … },
    "subscription_skips": [ … ],
    "orders": [ … ]
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Reactivate a cancelled subscription

Request

Reactivate a previously cancelled subscription

Path

tokenstringrequired

Query

next_bill_datestring(date)

curl -i -X POST \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/subscriptions/{token}/reactivate?next_bill_date=2019-08-24' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

success

Bodyapplication/json

subscriptionobject(Commerce::Subscription)required

subscription.idintegerrequired

subscription.subscription_tokenstringrequired

Example: "sb_1234567890"

subscription.next_bill_datestring or nullrequired

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

subscription.last_bill_datestring or null(date)

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

subscription.next_ship_datestring or null(date)

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

subscription.last_ship_datestring or null(date)

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

subscription.statusstringrequired

Enum"pending""active""paused""past_due""cancelled""trial"

Example: "active"

subscription.disabledboolean or null

Default false

Example: false

subscription.quantityinteger>= 1required

Default 1

Example: 1

subscription.pricenumberrequired

Example: 100

subscription.original_pricenumberrequired

Example: 100

subscription.attemptsinteger or null

Default 0

Example: 1

subscription.last_failed_atstring or null(date-time)

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

subscription.next_retry_atstring or null(date-time)

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

subscription.skipped_countinteger or null

Default 0

Example: 1

subscription.max_skipsinteger or null

Example: 1

subscription.trial_ends_atstring or null(date-time)

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

subscription.cancelled_atstring or null(date-time)

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

subscription.created_atstring(date-time)required

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

subscription.updated_atstring(date-time)required

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

subscription.notesstring or null

Example: "This is a sample commerce subscription"

subscription.in_trialbooleanrequired

Example: false

subscription.subscription_planobject(Commerce::SubscriptionPlan)required

subscription.subscription_plan.idintegerrequired

subscription.subscription_plan.namestringrequired

Example: "Test Subscription Plan"

subscription.subscription_plan.billing_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription.subscription_plan.billing_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription.subscription_plan.billing_frequency_in_wordsstringrequired

Example: "2 Months"

subscription.subscription_plan.shipping_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription.subscription_plan.shipping_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription.subscription_plan.volume_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription.subscription_plan.volume_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription.subscription_plan.trial_periodinteger or null>= 1

Example: 1

subscription.subscription_plan.trial_period_unitstring or null

Possible values: day, week, month, year

Example: "day"

subscription.subscription_plan.split_volumebooleanrequired

Default false

Example: true

subscription.subscription_plan.allow_skippingboolean or null

Default true

Example: true

subscription.subscription_plan.max_skipsinteger or null>= 1

Example: 1

subscription.subscription_plan.price_adjustment_typestring or null

Example: "percentage or fixed_amount"

subscription.subscription_plan.price_adjustment_amountnumber or null

Example: 10

subscription.subscription_plan.activeboolean or null

Default true

Example: true

subscription.subscription_plan.company_defaultboolean or null

Default false

Example: false

subscription.subscription_plan.created_atstring(date-time)required

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

subscription.subscription_plan.updated_atstring(date-time)required

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

subscription.subscription_plan.products_countinteger or null

Example: 10

subscription.subscription_plan.subscribers_countinteger or null

Example: 10

subscription.variantnull or objectrequired

One of:

null

subscription.customerobject(Customer)required

subscription.customer.idintegerrequired

subscription.customer.account_idstring or null

subscription.customer.first_namestring or null

subscription.customer.last_namestring or null

subscription.customer.full_namestringrequired

subscription.customer.emailstring\A[a-zA-Z0-9.!\#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-...required

subscription.customer.verified_emailboolean or null

Default false

subscription.customer.phonestring or null

subscription.customer.orders_countinteger or null

Default 0

subscription.customer.created_atstring(date-time)required

subscription.customer.display_total_spentstringrequired

subscription.customer.metadataobjectrequired

Default "{}"

subscription.customer.user_company_idinteger or null

subscription.customer.external_idstring or null

subscription.customer.last_order_idinteger or null

Example: 101

subscription.customer.notesstring or null

Example: "This is a note"

subscription.customer.activebooleanrequired

subscription.customer.total_spentnumber or stringrequired

Example: 100

subscription.customer.customer_notesArray of objects(CustomerNote)required

subscription.customer.customer_notes[].idintegerrequired

subscription.customer.customer_notes[].notestringrequired

subscription.customer.customer_notes[].user_company_idinteger or null

subscription.customer.customer_notes[].customer_idintegerrequired

subscription.customer.customer_notes[].resource_idinteger or null

subscription.customer.customer_notes[].resource_typestring or null

subscription.customer.customer_notes[].created_atstring(date-time)required

subscription.customer.default_addressobject or null(Address)

subscription.customer.addressesArray of arraysrequired

subscription.customer.is_repbooleanrequired

Example: true

subscription.customer.is_discardedbooleanrequired

Example: false

subscription.customer.payment_methodsArray of arraysrequired

subscription.addressobject(Address)required

subscription.address.idintegerrequired

subscription.address.namestringrequired

Example: "John Doe"

subscription.address.address1stringrequired

Example: "123 Main St"

subscription.address.address2string or null

Example: "Apt 4B"

subscription.address.address3string or null

Example: "Building 5"

subscription.address.citystringrequired

Example: "New York"

subscription.address.statestringrequired

Example: "NY"

subscription.address.subdivision_codestring or null

Example: "NY"

subscription.address.postal_codestringrequired

Example: "10001"

subscription.address.country_codestring or null

Example: "US"

subscription.address.defaultboolean or null

Use this address by default when there are multiple addresses

Default false

Example: true

subscription.address.first_namestringrequired

Example: "John"

subscription.address.last_namestringrequired

Example: "Doe"

subscription.payment_methodobject(Commerce::PaymentMethod)required

subscription.payment_method.idintegerrequired

subscription.payment_method.sourcestringrequired

Enum"apple_pay""paypal""card""iap""bread""affirm""google_pay""klarna""droplet""citcon"

subscription.payment_method.created_atstring(date-time)required

subscription.payment_method.updated_atstring(date-time)required

subscription.payment_method.defaultbooleanrequired

subscription.payment_method.payment_typestringrequired

Example: "Credit Card"

subscription.payment_method.detailsobjectrequired

subscription.currencyobject(Currency)required

subscription.currency.idintegerrequired

subscription.currency.namestring or null

Example: "United States Dollar"

subscription.currency.codestringrequired

Example: "USD"

subscription.currency.ratenumber or string or null

Example: 1

subscription.currency.activeboolean or null

Default false

Example: true

subscription.currency.symbolstring or null

Example: "$"

subscription.countryobject(Country)required

subscription.country.idintegerrequired

subscription.country.namestringrequired

Example: "United States"

subscription.country.isostringrequired

2-letter country code (ISO 3166-1 alpha-2)

Example: "US"

subscription.companyobject(Company)required

subscription.company.idintegerrequired

subscription.company.namestringrequired

Example: "Acme, Inc."

subscription.subscription_skipsArray of objects(Commerce::SubscriptionSkip)required

subscription.subscription_skips[].idintegerrequired

subscription.subscription_skips[].skipped_datestring(date)required

Example: "2025-01-01T00:00:00Z"

subscription.subscription_skips[].reasonnull

Example: "Customer requested to skip next billing"

subscription.subscription_skips[].created_atstring(date-time)required

Example: "2025-01-01T00:00:00Z"

subscription.subscription_skips[].updated_atstring(date-time)required

Example: "2025-01-01T00:00:00Z"

subscription.ordersArray of objects(Commerce::Order)required

subscription.orders[].idintegerrequired

subscription.orders[].first_namestring or null

subscription.orders[].last_namestring or null

subscription.orders[].emailstring or null

subscription.orders[].phonestring or null

subscription.orders[].order_numberstring or null

subscription.orders[].statusstringrequired

Enum"awaiting_payment""awaiting_shipment""shipped""delivered""archived""cancelled""failed_payment""draft"

subscription.orders[].order_typestringrequired

Enum"requested""purchased""imported""abandoned"

subscription.orders[].amountnumber or string or null

Default "0.0"

subscription.orders[].notestring or null

subscription.orders[].currency_codestring or null

subscription.orders[].created_atstring(date-time)required

subscription.orders[].updated_atstring(date-time)required

subscription.orders[].metadataobject or null

Default "{}"

subscription.orders[].tokenstringrequired

subscription.orders[].refundable_amountstringrequired

subscription.orders[].shipping_methodobjectrequired

subscription.orders[].items_quantityintegerrequired

Example: 5

metaobject

Response

application/json

{
  "subscription": {
    "id": 0,
    "subscription_token": "sb_1234567890",
    "next_bill_date": "2025-03-10T00:00:00Z",
    "last_bill_date": "2025-03-10T00:00:00Z",
    "next_ship_date": "2025-03-10T00:00:00Z",
    "last_ship_date": "2025-03-10T00:00:00Z",
    "status": "active",
    "disabled": false,
    "quantity": 1,
    "price": 100,
    "original_price": 100,
    "attempts": 1,
    "last_failed_at": "2025-03-10T00:00:00Z",
    "next_retry_at": "2025-03-10T00:00:00Z",
    "skipped_count": 1,
    "max_skips": 1,
    "trial_ends_at": "2025-03-10T00:00:00Z",
    "cancelled_at": "2025-03-10T00:00:00Z",
    "created_at": "2025-03-10T00:00:00Z",
    "updated_at": "2025-03-10T00:00:00Z",
    "notes": "This is a sample commerce subscription",
    "in_trial": false,
    "subscription_plan": { … },
    "variant": {},
    "customer": { … },
    "address": { … },
    "payment_method": { … },
    "currency": { … },
    "country": { … },
    "company": { … },
    "subscription_skips": [ … ],
    "orders": [ … ]
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Skip next billing

Request

Skip next billing

Path

tokenstringrequired

curl -i -X POST \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/subscriptions/{token}/skip_next_billing' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

success

Bodyapplication/json

subscriptionobject(Commerce::Subscription)required

subscription.idintegerrequired

subscription.subscription_tokenstringrequired

Example: "sb_1234567890"

subscription.next_bill_datestring or nullrequired

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

subscription.last_bill_datestring or null(date)

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

subscription.next_ship_datestring or null(date)

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

subscription.last_ship_datestring or null(date)

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

subscription.statusstringrequired

Enum"pending""active""paused""past_due""cancelled""trial"

Example: "active"

subscription.disabledboolean or null

Default false

Example: false

subscription.quantityinteger>= 1required

Default 1

Example: 1

subscription.pricenumberrequired

Example: 100

subscription.original_pricenumberrequired

Example: 100

subscription.attemptsinteger or null

Default 0

Example: 1

subscription.last_failed_atstring or null(date-time)

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

subscription.next_retry_atstring or null(date-time)

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

subscription.skipped_countinteger or null

Default 0

Example: 1

subscription.max_skipsinteger or null

Example: 1

subscription.trial_ends_atstring or null(date-time)

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

subscription.cancelled_atstring or null(date-time)

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

subscription.created_atstring(date-time)required

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

subscription.updated_atstring(date-time)required

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

subscription.notesstring or null

Example: "This is a sample commerce subscription"

subscription.in_trialbooleanrequired

Example: false

subscription.subscription_planobject(Commerce::SubscriptionPlan)required

subscription.subscription_plan.idintegerrequired

subscription.subscription_plan.namestringrequired

Example: "Test Subscription Plan"

subscription.subscription_plan.billing_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription.subscription_plan.billing_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription.subscription_plan.billing_frequency_in_wordsstringrequired

Example: "2 Months"

subscription.subscription_plan.shipping_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription.subscription_plan.shipping_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription.subscription_plan.volume_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription.subscription_plan.volume_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription.subscription_plan.trial_periodinteger or null>= 1

Example: 1

subscription.subscription_plan.trial_period_unitstring or null

Possible values: day, week, month, year

Example: "day"

subscription.subscription_plan.split_volumebooleanrequired

Default false

Example: true

subscription.subscription_plan.allow_skippingboolean or null

Default true

Example: true

subscription.subscription_plan.max_skipsinteger or null>= 1

Example: 1

subscription.subscription_plan.price_adjustment_typestring or null

Example: "percentage or fixed_amount"

subscription.subscription_plan.price_adjustment_amountnumber or null

Example: 10

subscription.subscription_plan.activeboolean or null

Default true

Example: true

subscription.subscription_plan.company_defaultboolean or null

Default false

Example: false

subscription.subscription_plan.created_atstring(date-time)required

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

subscription.subscription_plan.updated_atstring(date-time)required

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

subscription.subscription_plan.products_countinteger or null

Example: 10

subscription.subscription_plan.subscribers_countinteger or null

Example: 10

subscription.variantnull or objectrequired

One of:

null

subscription.customerobject(Customer)required

subscription.customer.idintegerrequired

subscription.customer.account_idstring or null

subscription.customer.first_namestring or null

subscription.customer.last_namestring or null

subscription.customer.full_namestringrequired

subscription.customer.emailstring\A[a-zA-Z0-9.!\#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-...required

subscription.customer.verified_emailboolean or null

Default false

subscription.customer.phonestring or null

subscription.customer.orders_countinteger or null

Default 0

subscription.customer.created_atstring(date-time)required

subscription.customer.display_total_spentstringrequired

subscription.customer.metadataobjectrequired

Default "{}"

subscription.customer.user_company_idinteger or null

subscription.customer.external_idstring or null

subscription.customer.last_order_idinteger or null

Example: 101

subscription.customer.notesstring or null

Example: "This is a note"

subscription.customer.activebooleanrequired

subscription.customer.total_spentnumber or stringrequired

Example: 100

subscription.customer.customer_notesArray of objects(CustomerNote)required

subscription.customer.customer_notes[].idintegerrequired

subscription.customer.customer_notes[].notestringrequired

subscription.customer.customer_notes[].user_company_idinteger or null

subscription.customer.customer_notes[].customer_idintegerrequired

subscription.customer.customer_notes[].resource_idinteger or null

subscription.customer.customer_notes[].resource_typestring or null

subscription.customer.customer_notes[].created_atstring(date-time)required

subscription.customer.default_addressobject or null(Address)

subscription.customer.addressesArray of arraysrequired

subscription.customer.is_repbooleanrequired

Example: true

subscription.customer.is_discardedbooleanrequired

Example: false

subscription.customer.payment_methodsArray of arraysrequired

subscription.addressobject(Address)required

subscription.address.idintegerrequired

subscription.address.namestringrequired

Example: "John Doe"

subscription.address.address1stringrequired

Example: "123 Main St"

subscription.address.address2string or null

Example: "Apt 4B"

subscription.address.address3string or null

Example: "Building 5"

subscription.address.citystringrequired

Example: "New York"

subscription.address.statestringrequired

Example: "NY"

subscription.address.subdivision_codestring or null

Example: "NY"

subscription.address.postal_codestringrequired

Example: "10001"

subscription.address.country_codestring or null

Example: "US"

subscription.address.defaultboolean or null

Use this address by default when there are multiple addresses

Default false

Example: true

subscription.address.first_namestringrequired

Example: "John"

subscription.address.last_namestringrequired

Example: "Doe"

subscription.payment_methodobject(Commerce::PaymentMethod)required

subscription.payment_method.idintegerrequired

subscription.payment_method.sourcestringrequired

Enum"apple_pay""paypal""card""iap""bread""affirm""google_pay""klarna""droplet""citcon"

subscription.payment_method.created_atstring(date-time)required

subscription.payment_method.updated_atstring(date-time)required

subscription.payment_method.defaultbooleanrequired

subscription.payment_method.payment_typestringrequired

Example: "Credit Card"

subscription.payment_method.detailsobjectrequired

subscription.currencyobject(Currency)required

subscription.currency.idintegerrequired

subscription.currency.namestring or null

Example: "United States Dollar"

subscription.currency.codestringrequired

Example: "USD"

subscription.currency.ratenumber or string or null

Example: 1

subscription.currency.activeboolean or null

Default false

Example: true

subscription.currency.symbolstring or null

Example: "$"

subscription.countryobject(Country)required

subscription.country.idintegerrequired

subscription.country.namestringrequired

Example: "United States"

subscription.country.isostringrequired

2-letter country code (ISO 3166-1 alpha-2)

Example: "US"

subscription.companyobject(Company)required

subscription.company.idintegerrequired

subscription.company.namestringrequired

Example: "Acme, Inc."

subscription.subscription_skipsArray of objects(Commerce::SubscriptionSkip)required

subscription.subscription_skips[].idintegerrequired

subscription.subscription_skips[].skipped_datestring(date)required

Example: "2025-01-01T00:00:00Z"

subscription.subscription_skips[].reasonnull

Example: "Customer requested to skip next billing"

subscription.subscription_skips[].created_atstring(date-time)required

Example: "2025-01-01T00:00:00Z"

subscription.subscription_skips[].updated_atstring(date-time)required

Example: "2025-01-01T00:00:00Z"

subscription.ordersArray of objects(Commerce::Order)required

subscription.orders[].idintegerrequired

subscription.orders[].first_namestring or null

subscription.orders[].last_namestring or null

subscription.orders[].emailstring or null

subscription.orders[].phonestring or null

subscription.orders[].order_numberstring or null

subscription.orders[].statusstringrequired

Enum"awaiting_payment""awaiting_shipment""shipped""delivered""archived""cancelled""failed_payment""draft"

subscription.orders[].order_typestringrequired

Enum"requested""purchased""imported""abandoned"

subscription.orders[].amountnumber or string or null

Default "0.0"

subscription.orders[].notestring or null

subscription.orders[].currency_codestring or null

subscription.orders[].created_atstring(date-time)required

subscription.orders[].updated_atstring(date-time)required

subscription.orders[].metadataobject or null

Default "{}"

subscription.orders[].tokenstringrequired

subscription.orders[].refundable_amountstringrequired

subscription.orders[].shipping_methodobjectrequired

subscription.orders[].items_quantityintegerrequired

Example: 5

metaobject

Response

application/json

{
  "subscription": {
    "id": 0,
    "subscription_token": "sb_1234567890",
    "next_bill_date": "2025-03-10T00:00:00Z",
    "last_bill_date": "2025-03-10T00:00:00Z",
    "next_ship_date": "2025-03-10T00:00:00Z",
    "last_ship_date": "2025-03-10T00:00:00Z",
    "status": "active",
    "disabled": false,
    "quantity": 1,
    "price": 100,
    "original_price": 100,
    "attempts": 1,
    "last_failed_at": "2025-03-10T00:00:00Z",
    "next_retry_at": "2025-03-10T00:00:00Z",
    "skipped_count": 1,
    "max_skips": 1,
    "trial_ends_at": "2025-03-10T00:00:00Z",
    "cancelled_at": "2025-03-10T00:00:00Z",
    "created_at": "2025-03-10T00:00:00Z",
    "updated_at": "2025-03-10T00:00:00Z",
    "notes": "This is a sample commerce subscription",
    "in_trial": false,
    "subscription_plan": { … },
    "variant": {},
    "customer": { … },
    "address": { … },
    "payment_method": { … },
    "currency": { … },
    "country": { … },
    "company": { … },
    "subscription_skips": [ … ],
    "orders": [ … ]
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Show orders created from the subscription

Request

Show a subscription

Path

tokenstringrequired

Query

sort_bystring

Sort field for orders

Enum"created_at""id""no_of_items""amount"

sort_directionstring

Sort direction

Default "desc"

Enum"asc""desc"

curl -i -X GET \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/subscriptions/{token}/orders?sort_by=created_at&sort_direction=asc' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

success

Bodyapplication/json

ordersArray of objects(Commerce::Order)required

orders[].idintegerrequired

orders[].first_namestring or null

orders[].last_namestring or null

orders[].emailstring or null

orders[].phonestring or null

orders[].order_numberstring or null

orders[].statusstringrequired

Enum"awaiting_payment""awaiting_shipment""shipped""delivered""archived""cancelled""failed_payment""draft"

orders[].order_typestringrequired

Enum"requested""purchased""imported""abandoned"

orders[].amountnumber or string or null

Default "0.0"

orders[].notestring or null

orders[].currency_codestring or null

orders[].created_atstring(date-time)required

orders[].updated_atstring(date-time)required

orders[].metadataobject or null

Default "{}"

orders[].tokenstringrequired

orders[].refundable_amountstringrequired

metaobject

Response

application/json

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

Send invoice email

Request

Send an invoice email for a cart without requiring subscription

Bodyapplication/json

Invoice email parameters

cart_tokenstringrequired

subscription_plan_idintegerrequired

curl -i -X POST \
  https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/subscriptions/send_invoice_email \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "cart_token": "string",
    "subscription_plan_id": 0
  }'

Responses

success

Bodyapplication/json

cart_tokenstringrequired

Example: "ct_ABC123"

metaobject

Response

application/json

{
  "cart_token": "ct_ABC123",
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

System Monitoring

Operations

Tax Categories

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

Variants

Operations

Webhook Schemas

Operations

Webhooks

Operations

Fluid Commerce APIs (1.0)

Admins

Agreements

ApplePay

Application Theme Templates

Application Themes

ApplicationThemeTemplates

Authentication

Callback Definitions

Callback Registrations

Callback Schemas

Carts

Categories

Collections

Companies

Company Admins

Company Custom Catch Ups

Company Discounts

Company Mobile Widgets

Company Pages

Pages

Company Popups

Company Settings - Checkout

Company Settings - Countries

Company Settings - Languages

Company Settings - Social Media

Company Settings - Warehouses

Company Webhook Events

Contacts

Currencies

Customer Orders

CustomerNotes

Customers

DAM Query

Dam

Default Libraries

DefaultMySites

Devices

Display Settings

Domains

Drop Zones

Droplet Categories

Droplet Installations

Droplets

Enrollment Packs

Enrollments

FairShare Order Journey

Fantasy Points

Feature Flags

File Resources

Fluid Pay

Form Elements

Forms

GlobalEmbeds

Impersonation

Inventory Levels

Labels

Menus

Metafield Definitions

Multi Factor Authentications

Multi-Factor Authentications

Notifications

Onboarding

Order Fulfillments

Orders

Payment

Payment Accounts

Payment Integrations

Payments

Paypal

Products

Prompts

Public Companies

Public Drop Zones

Ranks

Redirects

Refunds

Reps

Roles

Settings

Request

Request