/
CR
crayon
/
Crayon Group Customer API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 7h ago · Updated 3w ago
View markdown
crayon
Crayon Group Customer API
post
/api/v1/AgreementProducts
latest
OpenAPI 3.0.1
2026-08-04
163
173
381.2 KB
a04494a78f65
ActivityLogs
1
Addresses
2
AgreementProducts
4
get
/api/v1/AgreementProducts
post
/api/v1/AgreementProducts
post
/api/v1/AgreementProducts/file/xlsx
get
/api/v1/AgreementProducts/{partNumber}/supportedbillingcycles
AgreementReports
2
Agreements
1
Assets
7
AwsAccounts
3
AzurePlans
9
AzureUsage
1
BillingCycles
3
BillingStatements
7
BlogItems
1
Clients
6
Consumers
5
CrayonAccounts
4
CustomerTenantAgreements
2
CustomerTenants
8
CustomerToken
1
Exports
4
FacebookOrders
1
GoogleOrders
1
Groupings
5
InvoiceProfiles
5
Invoices
1
ManagementLinks
2
Me
1
Orders
2
OrganizationAccess
3
Organizations
4
Ping
1
ProductContainers
8
Programs
2
Publishers
2
PurchaseRequest
5
Regions
2
ResellerSalesPrices
6
ScheduledPurchaseRequest
2
Secrets
2
Subscriptions
24
UsageCost
6
Users
7
AgreementProducts
post
/api/v1/AgreementProducts
Request body
AgreementProductFilter
required
agreementTypeIds
AgreementType[]
nullable
page
integer
pageSize
integer
search
string
nullable
priceListId
integer
organizationId
integer
customerTenantId
integer
agreementId
integer
isTrial
boolean
nullable
agreementIds
integer[]
nullable
searchDate
string
date-time
nullable
include
AgreementProductsSubFilter
exclude
AgreementProductsSubFilter
sortKey
string
nullable
includeProductInformation
boolean
includeProductVariantInformation
boolean
includeEndOfSale
boolean
nullable
sortOrder
0
|
1
Response
Success
AgreementProduct[]
required
uniqueId
string
nullable
productType
0
|
1
|
2
|
3
productVariant
ProductVariant
agreement
ObjectReference
name
string
nullable
priceId
integer
recommendedRetailPrice
Price
salesPrice
Price
alternativeSalesPrice
Price
endOfSale
EndOfSale
priceListId
integer
priceListName
string
nullable
monthMultiplier
integer
priceCalculationType
0
|
1
|
2
|
3
|
4
agreementType
0
|
1
|
2
|
3
|
4
|
5
|
6
|
7
|
8
|
9
|
10
|
11
|
12
|
13
productInformation
ProductInformation
minimumQuantity
integer
maximumQuantity
integer
nullable
catalog
ObjectReference
productVariantInformation
ProductVariantInformation