Partner Billing API

The Partner Billing API allows partners to manage subscription details of Logitech Circle accessories that they are responsible for. Logitech will work with partners to determine the Service Plan Features, durations and pricing, and create a customized list of Billing Plans that the partner can use.

Authentication

Authentication using the Partner Billing API is supported via the OAuth2 client_credentials grant type. Client Credentials mode is when your server directly uses its client_id and client_secret to get a token on behalf of your service instead of a user scoped token. A Client Credentials token is requested using the normal Authentication token url, but using grant_type=client_credentials instead of the normal grant_type=authorization_code`.

Client Credentials tokens must only be issued and used directly by your servers. They can never be transmitted to any client/endpoint device, as they allow Partner wide changes not limited to a single user.

Billing Plan

A billing plan defines the Service Plan Features and their values. Logitech defines the billing plans available to a partner and the costs we charge you for them. The following calls allow you to see the billing plans associated with your partner setup:

Get All Billing Plans
Get Billing Plan by ID

Subscription

A Subscription is an instance of a Billing Plan that specifies a start time, expiration time, Account IdAccount Id - A unique non changing value to identify a particular Circle user account. Circle Account Id's are globally unique and are UUID v4 strings. The Account Id is not the same value as the Logitech Account Id found when introspecting an OAuth2 Authentication token. Example: 9385e6f9-70c3-45b2-62e4-ace3d027988a and one or more Accessory IdAccessory Id - A unique non changing value to identify a particular Accessory. Accessory Id's are globally unique and are UUID v4 strings. A new Accessory Id is assigned by the servers when a device is associated to an account for the first time. If the same physical device is re-associated to the same account, it will receive the same Accessory Id again. If the same physical device is re-associated to a different account, it will receive a new Accessory Id. Example: 70e3e6f9-70c3-45b2-62e4-ace3d027988a assigned to it. A subscription also defines what occurs when that subscription expires. A subscription applies to one or more Accessory IdAccessory Id - A unique non changing value to identify a particular Accessory. Accessory Id's are globally unique and are UUID v4 strings. A new Accessory Id is assigned by the servers when a device is associated to an account for the first time. If the same physical device is re-associated to the same account, it will receive the same Accessory Id again. If the same physical device is re-associated to a different account, it will receive a new Accessory Id. Example: 70e3e6f9-70c3-45b2-62e4-ace3d027988a's. The following calls interact with subscriptions:

Create Billing Subscription
Get All Subscriptions
Get Subscription by Id
Update Subscription by ID