Rate Cards
Rate Cards
Rate Cards
Archive a rate card
client.v1.contracts.rateCards.archive(RateCardArchiveParamsbody, RequestOptionsoptions?): dataIDRateCardArchiveResponse
post/v1/contract-pricing/rate-cards/archive
Create a rate card
client.v1.contracts.rateCards.create(RateCardCreateParamsbody, RequestOptionsoptions?): dataIDRateCardCreateResponse
post/v1/contract-pricing/rate-cards/create
List rate cards
client.v1.contracts.rateCards.list(RateCardListParamsparams?, RequestOptionsoptions?): CursorPage<idstringcreated_atstringcreated_bystringnamestringaliasesarraycredit_type_conversionsarraycustom_fieldsRecord<string, string>descriptionstringfiat_credit_typeCreditTypeDataRateCardListResponse>
post/v1/contract-pricing/rate-cards/list
Get a rate card
client.v1.contracts.rateCards.retrieve(RateCardRetrieveParamsbody, RequestOptionsoptions?): dataDataRateCardRetrieveResponse
post/v1/contract-pricing/rate-cards/get
Get a rate schedule
client.v1.contracts.rateCards.retrieveRateSchedule(RateCardRetrieveRateScheduleParamsparams, RequestOptionsoptions?): dataarraynext_pageunionRateCardRetrieveRateScheduleResponse
post/v1/contract-pricing/rate-cards/getRateSchedule
Update a rate card
client.v1.contracts.rateCards.update(RateCardUpdateParamsbody, RequestOptionsoptions?): dataIDRateCardUpdateResponse
post/v1/contract-pricing/rate-cards/update
Rate CardsNamed Schedules
Get a contract's named schedule
client.v1.contracts.rateCards.namedSchedules.retrieve(NamedScheduleRetrieveParamsbody, RequestOptionsoptions?): dataarrayNamedScheduleRetrieveResponse
post/v1/contracts/getNamedSchedule
Update a contract's named schedule
client.v1.contracts.rateCards.namedSchedules.update(NamedScheduleUpdateParamsbody, RequestOptionsoptions?): void
post/v1/contracts/updateNamedSchedule
Rate CardsProduct Orders
Set the rate card products order
client.v1.contracts.rateCards.productOrders.set(ProductOrderSetParamsbody, RequestOptionsoptions?): dataIDProductOrderSetResponse
post/v1/contract-pricing/rate-cards/setRateCardProductsOrder
Update the rate card products order
client.v1.contracts.rateCards.productOrders.update(ProductOrderUpdateParamsbody, RequestOptionsoptions?): dataIDProductOrderUpdateResponse
post/v1/contract-pricing/rate-cards/moveRateCardProducts
Rate CardsRates
Add a rate
client.v1.contracts.rateCards.rates.add(RateAddParamsbody, RequestOptionsoptions?): dataDataRateAddResponse
post/v1/contract-pricing/rate-cards/addRate
Add rates
client.v1.contracts.rateCards.rates.addMany(RateAddManyParamsbody, RequestOptionsoptions?): dataIDRateAddManyResponse
post/v1/contract-pricing/rate-cards/addRates
Get rates
client.v1.contracts.rateCards.rates.list(RateListParamsparams, RequestOptionsoptions?): CursorPage<entitledbooleanproduct_custom_fieldsRecord<string, string>product_idstringproduct_namestringproduct_tagsarrayrateRatestarting_atstringbilling_frequencyunioncommit_rateCommitRateending_beforestringpricing_group_valuesRecord<string, string>RateListResponse>
post/v1/contract-pricing/rate-cards/getRates