Cloud Channel API: Nodejs Client
This library is considered to bestable. The code surface will not change in backwards-incompatible waysunless absolutely necessary (e.g. because of critical security issues) or withan extensive deprecation period. Issues and requests againststable librariesare addressed with the highest priority
Cloud Channel API client for Node.js
A comprehensive list of changes in each version may be found inthe CHANGELOG.
Read more about the client libraries for Cloud APIs, including the olderGoogle APIs Client Libraries, inClient Libraries Explained.
Table of contents:
Quickstart
Before you begin
- Select or create a Cloud Platform project.
- Enable billing for your project.
- Enable the Cloud Channel API API.
- Set up authentication so you can access theAPI from your local workstation.### Installing the client library
npm install @google-cloud/channelSamples
Samples are in thesamples/ directory. Each sample'sREADME.md has instructions for running its sample.
| Sample | Source Code |
|---|---|
| fetch report results | source code |
| list reports | source code |
| run report job | source code |
| activate entitlement | source code |
| cancel entitlement | source code |
| change offer | source code |
| change parameters | source code |
| change renewal settings | source code |
| check cloud identity accounts exist | source code |
| create channel partner link | source code |
| create channel partner repricing config | source code |
| create customer | source code |
| create customer repricing config | source code |
| create entitlement | source code |
| delete channel partner repricing config | source code |
| delete customer | source code |
| delete customer repricing config | source code |
| get channel partner link | source code |
| get channel partner repricing config | source code |
| get customer | source code |
| get customer repricing config | source code |
| get entitlement | source code |
| import customer | source code |
| list channel partner links | source code |
| list channel partner repricing configs | source code |
| list customer repricing configs | source code |
| list customers | source code |
| list entitlement changes | source code |
| list entitlements | source code |
| list offers | source code |
| list products | source code |
| list purchasable offers | source code |
| list purchasable skus | source code |
| list sku group billable skus | source code |
| list sku groups | source code |
| list skus | source code |
| list subscribers | source code |
| list transferable offers | source code |
| list transferable skus | source code |
| lookup offer | source code |
| provision cloud identity | source code |
| query eligible billing accounts | source code |
| register subscriber | source code |
| start paid service | source code |
| suspend entitlement | source code |
| transfer entitlements | source code |
| transfer entitlements to google | source code |
| unregister subscriber | source code |
| update channel partner link | source code |
| update channel partner repricing config | source code |
| update customer | source code |
| update customer repricing config | source code |
| cloud | source code |
Supported Node.js Versions
Our client libraries follow theNode.js release schedule.Libraries are compatible with all currentactive andmaintenance versions ofNode.js.If you are using an end-of-life version of Node.js, we recommend that you updateas soon as possible to an actively supported LTS version.
Google's client libraries support legacy versions of Node.js runtimes on abest-efforts basis with the following warnings:
- Legacy versions are not tested in continuous integration.
- Some security patches and features cannot be backported.
- Dependencies cannot be kept up-to-date.
Client libraries targeting some end-of-life versions of Node.js are available, andcan be installed through npmdist-tags.The dist-tags follow the naming conventionlegacy-(version).For example,npm install @google-cloud/channel@legacy-8 installs client librariesfor versions compatible with Node.js 8.
Versioning
This library followsSemantic Versioning.
More Information:Google Cloud Platform Launch Stages
Contributing
Contributions welcome! See theContributing Guide.
Please note that thisREADME.mdand a variety of configuration files in this repository (including.nycrc andtsconfig.json)are generated from a central template.
License
Apache Version 2.0
SeeLICENSE
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-09 UTC.