Clearway Documentation
  • Home
  • Guides
  • Merchant API
  • Investor Read API
Back to Merchant APIInformation
Analytics
    Read analyticspost
Checkout
    Create checkout sessionspostCreate payment intentpost
Customers
    Manage customerspost
Orders
    Get orderpostRead orderspost
Payment links
    Create payment linkspostList payment linkspost
Payments
    Preview platform feespostProcess refundspostResolve embed displaypost
Products
    Write merchant couponspostWrite productspostDelete productpostGet productpostRead merchant couponspostRead productspostUpdate merchant couponpostUpdate productpost
Subscriptions
    Cancel subscriptionspostChange subscription planspostRead subscriptionspostPreview subscription plan changespost
Schemas
powered by Zudoku
Clearway Documentation
Clearway Documentation

Schemas

Download schema

MerchantApiSuccessEnvelope

success
​boolean · required
Additional properties are allowed

MerchantApiProductDetail

Public GET_PRODUCT product body — trial_period_days and aliases are never present (H-1).
productId
​string
name
​string
description
​string
amountCents
​integer
currency
​string
status
​string
createdAt
​string · date-time
updatedAt
​string · date-time
​object[]

MerchantApiGetProductSuccess

success
​boolean · required
​MerchantApiProductDetail · required

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

Additional properties are allowed

MerchantApiErrorEnvelope

success
​boolean · required
error
​string · required
code
​string
On this page
  • MerchantApiSuccessEnvelope
  • MerchantApiProductDetail
  • MerchantApiGetProductSuccess
  • MerchantApiErrorEnvelope