---
title: "Get merchant status"
method: GET
path: "/payments/merchant"
tags: ["Payments"]
---

# Get merchant status

`GET /payments/merchant`

## Request

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

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.

## Response `200`

Your merchant status.

- MerchantStatus
  - `payments` object, required
    - `enabled` boolean, required: True if you can use the Payments API right now. False until the current terms are accepted, and while suspended.
    - `terms_version` string, nullable, required
    - `terms_accepted_at` string, date-time, nullable, required
    - `terms_current` boolean, required: False if the terms changed since you accepted them. Always true for workspaces Comms set up before open signup.
    - `suspended` boolean, required
    - `suspended_reason` string, nullable, required
    - `curated` boolean, required: True for workspaces Comms set up before open signup. They sell only products Comms reviewed.
  - `shopify` object, nullable, required: Null if you've never connected a store.
    - `shop_domain` string, required
    - `shop_name` string, nullable, required
    - `status` 'active' | 'uninstalled', required
    - `install_method` 'oauth' | 'manual', required: oauth: installed the Comms app. manual: connected with credentials before open signup.
    - `installed_at` string, date-time, nullable, required
    - `uninstalled_at` string, date-time, nullable, required
    - `needs_reconnect` boolean, required: True when Shopify stopped letting Comms reach the store. Reopen Comms from Shopify to authorize the same store again.
  - `install_available` boolean, required: False if the Comms Shopify app can't take installs right now.
  - `terms` object, required
    - `current_version` string, required
    - `url` string, uri, required
  - `whop` object, nullable
    - `company_id` string
    - `company_name` string, nullable
    - `status` 'active' | 'disconnected'
    - `webhook_configured` boolean
    - `connected_at` string, date-time, nullable

## Other responses

- `401`: API key is missing or wrong.
- `403`: Your key is missing the comms_read scope.

---

[API](https://skmtc.dev/osis/apis/comms-api.md) · [All operations](https://skmtc.dev/osis/apis/comms-api/llms.txt) · [OpenAPI document](https://skmtc.dev/osis/apis/comms-api/revisions/59a4c0ba8936?raw)