Skip to content
Lark
Book a demoContact usGet started
API Reference

Rate Catalogs

Create Rate Catalog
client.rateCatalogs.create(RateCatalogCreateParams { description, name } body, RequestOptionsoptions?): RateCatalogCreateResponse { id, description, name, rate_count }
post/rate-catalogs
List Rate Catalogs
client.rateCatalogs.list(RateCatalogListParams { limit, offset } query?, RequestOptionsoptions?): RateCatalogListResponse { has_more, rate_catalogs }
get/rate-catalogs
Get Rate Catalog
client.rateCatalogs.retrieve(stringrateCatalogID, RequestOptionsoptions?): RateCatalogRetrieveResponse { id, description, name, rate_count }
get/rate-catalogs/{rate_catalog_id}
List Rates In Catalog
client.rateCatalogs.listRates(stringrateCatalogID, RateCatalogListRatesParams { limit, offset } query?, RequestOptionsoptions?): RateCatalogListRatesResponse { has_more, rates }
get/rate-catalogs/{rate_catalog_id}/rates
Add Rates To Rate Catalog
client.rateCatalogs.addRates(stringrateCatalogID, RateCatalogAddRatesParams { billing_interval, fixed_rates, usage_based_rates } body, RequestOptionsoptions?): RateCatalogAddRatesResponse { id, description, name, rate_count }
post/rate-catalogs/{rate_catalog_id}/add_rates