Organizations

Organization Entities Endpoints Endpoint Description entities Get a specific entity entitiesCreate Create an entity

The shop collaboration feature lets you invite other users to work together on your shop. If a user is already registered in the system, they are prompted to join your shop. For new users, they are guided to sign up for a new account. When a new user registers, they automatically accept any pending invites associated with their email address.

The Invoices API provides detailed information regarding your shop's subscription payments. This includes payment status, dates, amounts, and the subscription plan details. It's an essential tool for tracking and managing your shop's financial obligations related to its subscription.

Organizations Endpoints Endpoint Description organizations Get a specific organization organizationsAcceptOwnership

While processing payments for the shop, we securely store your payment credentials as a Payment Method. All sensitive payment information is securely handled by

The Plan API offers visibility into your shop's plan limits and quotas through the plan query. As we anticipate the capability to adjust plan limits and quotas on a per-shop basis in the future, effectively customizing plans, it's crucial to use this API to govern user interfaces rather than relying on generic plan information tables.

Roles streamline the management of your user permissions. There are built-in roles available, and you also have the option to create custom roles. Essentially, each role comprises a set of permissions and is identified by a specific name.

This API provides information about usage-based services employed by a shop over a selected time period, such as additional orders, returns, or SMS. It's a valuable resource for monitoring and managing your shop's utilization of various services.