Products

Download schema

Write merchant coupons

POST

https://api-dev.clearway.to

/CREATE_MERCHANT_COUPON

Create Stripe Connect coupons on your connected account (percent_off or amount_off). Never writes platform promo_codes.

Write merchant coupons › Headers

x-cid

string

Optional correlation id for support trails.

x-brand-id

string

Optional platform brand slug for multi-brand merchants.

Idempotency-Key

string

Stable key for safe retries on money-moving requests.

Write merchant coupons › Request Body

name

string

percentOff

number

duration

string

Write merchant coupons › Responses

Success

MerchantApiSuccessEnvelope

success

boolean · required

Write products

POST

https://api-dev.clearway.to

/CREATE_PRODUCT

Create, update, or delete catalog products via API key.

Write products › Headers

x-cid

string

Optional correlation id for support trails.

x-brand-id

string

Optional platform brand slug for multi-brand merchants.

Idempotency-Key

string

Stable key for safe retries on money-moving requests.

Write products › Request Body

name

string

amount_cents

number

mode

string

recurring_interval

string

Write products › Responses

Success

MerchantApiSuccessEnvelope

success

boolean · required

Delete product

POST

https://api-dev.clearway.to

/DELETE_PRODUCT

Delete a catalog product via API key (write:products).

Delete product › Headers

x-cid

string

Optional correlation id for support trails.

x-brand-id

string

Optional platform brand slug for multi-brand merchants.

Idempotency-Key

string

Stable key for safe retries on money-moving requests.

Delete product › Request Body

productId

string

Delete product › Responses

Success

MerchantApiSuccessEnvelope

success

boolean · required

Get product

POST

https://api-dev.clearway.to

/GET_PRODUCT

Fetch a single catalog product by Clearway product id. Public GET never includes trial fields (trial_period_days / aliases) — use LIST_PRODUCTS for merchant catalog management including trials.

Get product › Headers

x-cid

string

Optional correlation id for support trails.

x-brand-id

string

Optional platform brand slug for multi-brand merchants.

Get product › Request Body

productId

string

includeImages

boolean

Get product › Responses

Success

MerchantApiGetProductSuccess

success

boolean · required

MerchantApiProductDetail · required

Public GET_PRODUCT product body — trial_period_days and aliases are never present (H-1).

POST/GET_PRODUCT

curl https://api-dev.clearway.to/GET_PRODUCT \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "productId": "00000000-0000-4000-8000-000000000001",
  "includeImages": true
}'

Example Request Body

{
  "productId": "00000000-0000-4000-8000-000000000001",
  "includeImages": true
}

json

application/json

Example Responses

{
  "success": true,
  "product": {
    "productId": "productId",
    "name": "name",
    "description": "description",
    "amountCents": 0,
    "currency": "currency",
    "status": "status",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "images": [
      {}
    ]
  }
}

json

application/json

Read merchant coupons

POST

https://api-dev.clearway.to

/LIST_MERCHANT_COUPONS

List Stripe Connect coupons on your connected account. Distinct from platform promo_codes (Clearway fee packages).

Read merchant coupons › Headers

x-cid

string

Optional correlation id for support trails.

x-brand-id

string

Optional platform brand slug for multi-brand merchants.

Read merchant coupons › Request Body

limit

number

Read merchant coupons › Responses

Success

MerchantApiSuccessEnvelope

success

boolean · required

Read products

POST

https://api-dev.clearway.to

/LIST_PRODUCTS

List or fetch merchant products and catalog data.

Read products › Headers

x-cid

string

Optional correlation id for support trails.

x-brand-id

string

Optional platform brand slug for multi-brand merchants.

Read products › Request Body

limit

number

active

boolean

Read products › Responses

Success

MerchantApiSuccessEnvelope

success

boolean · required

Update merchant coupon

POST

https://api-dev.clearway.to

/UPDATE_MERCHANT_COUPON

Update a Stripe Connect coupon name on your connected account. Distinct from platform promo_codes.

Update merchant coupon › Headers

x-cid

string

Optional correlation id for support trails.

x-brand-id

string

Optional platform brand slug for multi-brand merchants.

Idempotency-Key

string

Stable key for safe retries on money-moving requests.

Update merchant coupon › Request Body

stripeCouponId

string

name

string

Update merchant coupon › Responses

Success

MerchantApiSuccessEnvelope

success

boolean · required

Update product

POST

https://api-dev.clearway.to

/UPDATE_PRODUCT

Update a catalog product via API key (write:products).

Update product › Headers

x-cid

string

Optional correlation id for support trails.

x-brand-id

string

Optional platform brand slug for multi-brand merchants.

Idempotency-Key

string

Stable key for safe retries on money-moving requests.

Update product › Request Body

productId

string

name

string

amount_cents

number

Update product › Responses

Success

MerchantApiSuccessEnvelope

success

boolean · required

Payments Subscriptions

Clearway Documentation

Products

Download schema

Write merchant coupons

POST

https://api-dev.clearway.to

/CREATE_MERCHANT_COUPON

Create Stripe Connect coupons on your connected account (percent_off or amount_off). Never writes platform promo_codes.

Write merchant coupons › Headers

x-cid

string

Optional correlation id for support trails.

x-brand-id

string

Optional platform brand slug for multi-brand merchants.

Idempotency-Key

string

Stable key for safe retries on money-moving requests.

Write merchant coupons › Request Body

name

string

percentOff

number

duration

string

Write merchant coupons › Responses

Success

MerchantApiSuccessEnvelope

success

boolean · required

Write products

POST

https://api-dev.clearway.to

/CREATE_PRODUCT

Create, update, or delete catalog products via API key.

Write products › Headers

x-cid

string

Optional correlation id for support trails.

x-brand-id

string

Optional platform brand slug for multi-brand merchants.

Idempotency-Key

string

Stable key for safe retries on money-moving requests.

Write products › Request Body

name

string

amount_cents

number

mode

string

recurring_interval

string

Write products › Responses

Success

MerchantApiSuccessEnvelope

success

boolean · required

Delete product

POST

https://api-dev.clearway.to

/DELETE_PRODUCT

Delete a catalog product via API key (write:products).

Delete product › Headers

x-cid

string

Optional correlation id for support trails.

x-brand-id

string

Optional platform brand slug for multi-brand merchants.

Idempotency-Key

string

Stable key for safe retries on money-moving requests.

Delete product › Request Body

productId

string

Delete product › Responses

Success

MerchantApiSuccessEnvelope

success

boolean · required

Get product

POST

https://api-dev.clearway.to

/GET_PRODUCT

Fetch a single catalog product by Clearway product id. Public GET never includes trial fields (trial_period_days / aliases) — use LIST_PRODUCTS for merchant catalog management including trials.

Get product › Headers

x-cid

string

Optional correlation id for support trails.

x-brand-id

string

Optional platform brand slug for multi-brand merchants.

Get product › Request Body

productId

string

includeImages

boolean

Get product › Responses

Success

MerchantApiGetProductSuccess

success

boolean · required

MerchantApiProductDetail · required

Public GET_PRODUCT product body — trial_period_days and aliases are never present (H-1).

POST/GET_PRODUCT

curl https://api-dev.clearway.to/GET_PRODUCT \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "productId": "00000000-0000-4000-8000-000000000001",
  "includeImages": true
}'

Example Request Body

{
  "productId": "00000000-0000-4000-8000-000000000001",
  "includeImages": true
}

json

application/json

Example Responses

{
  "success": true,
  "product": {
    "productId": "productId",
    "name": "name",
    "description": "description",
    "amountCents": 0,
    "currency": "currency",
    "status": "status",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "images": [
      {}
    ]
  }
}

json

application/json

Read merchant coupons

POST

https://api-dev.clearway.to

/LIST_MERCHANT_COUPONS

List Stripe Connect coupons on your connected account. Distinct from platform promo_codes (Clearway fee packages).

Read merchant coupons › Headers

x-cid

string

Optional correlation id for support trails.

x-brand-id

string

Optional platform brand slug for multi-brand merchants.

Read merchant coupons › Request Body

limit

number

Read merchant coupons › Responses

Success

MerchantApiSuccessEnvelope

success

boolean · required

Read products

POST

https://api-dev.clearway.to

/LIST_PRODUCTS

List or fetch merchant products and catalog data.

Read products › Headers

x-cid

string

Optional correlation id for support trails.

x-brand-id

string

Optional platform brand slug for multi-brand merchants.

Read products › Request Body

limit

number

active

boolean

Read products › Responses

Success

MerchantApiSuccessEnvelope

success

boolean · required

Update merchant coupon

POST

https://api-dev.clearway.to

/UPDATE_MERCHANT_COUPON

Update a Stripe Connect coupon name on your connected account. Distinct from platform promo_codes.

Update merchant coupon › Headers

x-cid

string

Optional correlation id for support trails.

x-brand-id

string

Optional platform brand slug for multi-brand merchants.

Idempotency-Key

string

Stable key for safe retries on money-moving requests.

Update merchant coupon › Request Body

stripeCouponId

string

name

string

Update merchant coupon › Responses

Success

MerchantApiSuccessEnvelope

success

boolean · required

Update product

POST

https://api-dev.clearway.to

/UPDATE_PRODUCT

Update a catalog product via API key (write:products).

Update product › Headers

x-cid

string

Optional correlation id for support trails.

x-brand-id

string

Optional platform brand slug for multi-brand merchants.

Idempotency-Key

string

Stable key for safe retries on money-moving requests.

Update product › Request Body

productId

string

name

string

amount_cents

number

Update product › Responses

Success

MerchantApiSuccessEnvelope

success

boolean · required

Payments Subscriptions