Crayon API Documentation

Topics

• Getting Started
  • Authentication
  • Developing using the API
  • Swagger
• Scenarios
  • Authentication
    • Get clients
    • Get client
    • Get token
  • Organization
    • Get organizations
    • Get organization
    • Get organization access to grant
  • Manage users
    • Get users
    • Get user by id
    • Get user by username
    • Create User
    • Update User
    • Delete User
    • Change User Password
  • Manage customer tenant
    • Get customer tenants
    • Get customer tenant
    • Get customer tenant (detailed)
    • Create customer tenant
    • Add existing customer tenant
    • Update customer tenant
  • Manage agreements
    • Get agreements
    • Get consented agreements for customer tenant
    • Consent agreement for customer tenant
  • Manage subscriptions
    • Get subscriptions
    • Get subscription
    • Create subscription
    • Update subscription
    • Get subscription addon offers
    • Set Subscription addon
    • Get subscription upgrade eligibility
    • Get subscription upgrades
    • Create subscription upgrade
    • Schedule Next Term Instructions
    • Get coterminosity dates
    • Create New Commerce Orders
    • Get subscription unit price
  • Manage Azure Plan
    • Provision Azure Plan
    • Get Azure Plan by id
    • Cancel Azure Subscription
    • Enable Azure Subscription
    • Rename Azure Subscription
    • Set Admin For Azure Subscription
  • Products
    • Get agreement products
  • Billing and invoicing
    • Get addresses
    • Get address
    • Get invoice profile
    • Get invoice profiles
    • Create invoice profile
    • Update invoice profile
    • Get billing statements
    • Get billing statement excel file
    • Get billing statement reconciliation file
    • Get billing statement json file
  • Usage costs
    • Get usage costs by category
    • Get usage costs by organization
    • Get usage costs by sub category
    • Get usage costs by subscription
  • Management links
    • Get management links
    • Get management links grouped
  • Azure Usage
    • Get Azure Usage
  • Ordering Software/Reserved Instances
    • Verify Order
    • Checkout Order
  • Scheduled purchase request
    • Get all Scheduled Purchase Requests
    • Cancel Scheduled Purchase Request by ObjectReferenceId and OrderingNumber
  • Manage exports
    • Generate License-based Usage Report
    • Get export queue
    • Download custom export excel file
    • Delete Export Queue Item
• Resources
  • PurchaseRequestOrder
  • Address
  • AddressData
  • AggregationItem
  • Agreement
  • AgreementAccess
  • AzurePlan
  • AzureUsage
  • BillingStatement
  • BillingStatementFile
  • BillingStatementReconciliationFile
  • BillingStatementRecordsFile
  • CategoryUsageCost
  • Client
  • CustomerTenant
  • CustomerTenantAddress
  • CustomerTenantCompany
  • CustomerTenantContact
  • CustomerTenantDetailed
  • CustomerTenantProfile
  • CustomerTenantReference
  • CustomerTenantUser
  • InvoiceProfile
  • ManagementLink
  • ObjectReference
  • Organization
  • OrganizationAccess
  • OrganizationUsageCost
  • ProductReference
  • ScheduledNextTermInstructions
  • CoterminositySubscriptions
  • Secret
  • ServiceAccountAgreement
  • SubcategoryUsageCost
  • Subscription
  • SubscriptionAddOn
  • SubscriptionTags
  • SubscriptionTransition
  • SubscriptionTransitionEligibility
  • SubscriptionDetailed
  • SubscriptionUsageCost
  • SubscriptionAddOnOffer
  • SubscriptionAddOnOfferCollection
  • PostSubscriptionAddOn
  • SubscriptionPrice
  • LicenseBasedReportRequest
  • TimeRangeReference
  • ExportQueueResult
  • ExportQueueItem
  • Token
  • User
  • AgreementProductFilter
  • CategoryUsageCostCollection
  • CustomerTenantCollection
  • OrganizationCollection
  • OrganizationAccessCollection
  • OrganizationUsageCostCollection
  • SubcategoryUsageCostCollection
  • SubscriptionCollection
  • SubscriptionUsageCostCollection
• Samples
  • Order Nce products
  • List of products

Related Resources

• CrayonApi Github

• CrayonApi Nuget

• CrayonApi Sample

• CrayonApi Open API

Was this page helpful?

Your feedback about this content is important. Let us know what you think. Yes No

Was this page helpful?

Sorry this wasn't helpful. characters remaining Submit Skip this

✖

Sending feedback...

Thank you for your feedback!

Error during submission!