Payments

Get merchant status

Needs comms_read. Shows whether the Payments API is on, whether it's suspended, which terms were accepted, and which Shopify store is connected. Works even when the Payments API is off or suspended. For stores connected with the Comms app, it also restores missing Shopify webhooks, at most once an hour.

get/payments/merchant

Request

  • Base URL: https://osis.co/api/v1/comms
  • URL: https://osis.co/api/v1/comms/payments/merchant
  • Auth: HTTP bearer

Response

Your merchant status.

install_availableboolean required

False if the Comms Shopify app can't take installs right now.

Example response

{
  "payments": {
    "terms_version": "2026-09-23"
  },
  "shopify": {
    "shop_domain": "example.myshopify.com"
  },
  "terms": {
    "current_version": "2026-09-23",
    "url": "https://comms.osis.co/merchant-terms"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.