Skip to main content
Connector guides

Connect Crayon

Crayon is a global software and cloud distributor, and its partner platform, Cloud-iQ, is where a partner buys and manages Microsoft CSP (including the New Commerce licences), Azure Plans, AWS, Google…

Written By Christopher Scaminaci

Last updated About 2 hours ago

Crayon is a global software and cloud distributor, and its partner platform, Cloud-iQ, is where a partner buys and manages Microsoft CSP (including the New Commerce licences), Azure Plans, AWS, Google and Adobe subscriptions for its end customers and reads the bills that follow. Crayon is now part of SoftwareOne, but its API is still Crayon-branded end to end, so this connector is too. StackJack talks to your Cloud-iQ partner tenant, and one connection reaches every customer that tenant manages.

Connecting Crayon to StackJack gives your AI assistant a family of crayon_ MCP tools. MCP (Model Context Protocol) tools are the standardized commands an AI assistant can call through StackJack. With them, your AI can:

  • Answer "what does this customer have and what does it cost": list your organizations and customer tenants, then every subscription with its quantity, status, renewal date and unit price, filtered by customer, publisher or status
  • See what can change and when: the upgrade targets a subscription is eligible for, the terms and billing cycles it can switch to, the add-ons on offer, the conversion options and the coterminosity dates that line a new seat up with an existing end date
  • Reconcile the month: billing statements, grouped statements, invoices, invoice profiles, groupings, usage cost by organization, subscription, category, sub category or resource group, and the NCE license-based export
  • Pull the files Crayon produces: billing statement workbooks, reconciliation CSVs, the billing records file, generated exports and the product price-list workbook, each handed back as a download link
  • Check Azure: the Azure Plan behind a customer tenant, its Azure subscriptions, and a month of usage for any of them
  • Browse the catalog: the products you can buy under your agreements (by part number, publisher, program and billing cycle), agreements, programs, publishers and regions
  • Review access and activity: Cloud-iQ users, which organizations each can reach, the activity log, and the API user's own profile
  • Buy and change (on Pro plans): verify and check out an order, create a Microsoft NCE subscription, change seats, status and renewals, add add-ons, upgrade or convert a subscription, create, rename and cancel Azure subscriptions, set reseller prices, and manage customer tenants, users, invoice profiles, groupings and carts

How StackJack authenticates to Crayon

Crayon signs a partner integration in with two things at once, and StackJack needs all four values:

  • An API client: a Client ID and a Client Secret, created in Cloud-iQ under Clients.
  • A Cloud-iQ API user: a user name and a password, created in Cloud-iQ under Users.

StackJack exchanges the four values for a short-lived access token and renews it by itself, so there is nothing to refresh and no expiry to track. The API user decides what StackJack can see and do: its Cloud-iQ role and the organizations it has been given access to are the limits, and Crayon has no narrower scopes to choose from. Crayon does not document which actions each role may take.

Make that API user a dedicated account for StackJack. Do not reuse a person's own login. If that person changes their password, leaves the company or switches on multi-factor sign-in, every Crayon call from StackJack stops, and a wrong password can lock the user out of Cloud-iQ.

Steps

  1. Check you have a Tenant administrator account in Cloud-iQ. Crayon's API is for Crayon partners, and its authentication guide says to request a Tenant administrator account from your Crayon contact before using the API. If you do not have one, ask your Crayon contact.
  2. Create an API client. Sign in to Cloud-iQ, open the Clients page and create a client for StackJack. Copy its Client ID and Client Secret.
  3. Create a dedicated API user. Open the Users page and create a new user used only by StackJack. Give it access to the organizations StackJack should reach. Crayon's guide asks for a Tenant administrator account for API sign-in and does not say what a regular user can do, so if a call is refused, check this user's role first.
  4. Keep that user free of a second sign-in factor. StackJack signs in with a user name and password and cannot answer a multi-factor prompt. Crayon does not say whether an API user can be exempt, so if the connection fails with a password you know is right, ask your Crayon contact.
  5. Enter the four values in StackJack. Open Connectors, choose Crayon and enter the Client ID, the Client Secret, the API user's user name and the API user's password. There is no address to enter: Crayon's API address is fixed.
  6. Optional: enter a default organization ID. If you work in one Crayon organization, enter its numeric ID and the tools that take an optional organization use it whenever your AI does not name one. A request that already names a person (for example, the user who owns a cart or report, or the user who sent it) or a list of organizations is not limited to the default, so it still finds that person's records in every organization. Your AI can list the IDs with the organizations tool.
  7. Run a Test Connection. A failure here is almost always one of the four values mistyped, a locked or multi-factor-protected API user, or an API user that Cloud-iQ refuses the organizations list.

Changing these later

Open Configure on the Crayon connector and change what you need. All four values, and the optional default organization ID, are asked for again on every save: nothing is kept when a box is left blank, and an empty default organization ID removes the default. If the API user's password changes in Cloud-iQ, enter the new one here straight away.

If Crayon refuses the sign-in, StackJack does not keep trying. It remembers the refusal for a few minutes so a burst of requests cannot deepen a lockout, and saving the connector again tries immediately.

What to know before your AI uses this connector

Writes here are real money, and Crayon has no sandbox

Placing an order, creating a subscription, creating a new customer tenant, changing seats, status or renewals, adding an add-on, converting or upgrading a subscription, creating or cancelling an Azure subscription and changing a reseller price all buy something or change what a customer is billed, and Crayon offers no test environment to try them in. All of them need the Pro tier, and every one is marked so that your AI application can ask you to confirm before it runs. Whether it does depends on that application's own settings: see Destructive tools and confirmation and review it before you grant the Pro tools.

The marking goes further than purchases. These are also marked, because they cannot be undone or reach further than they look:

  • Deleting a customer tenant, user, consumer, invoice profile, grouping, product container, export, set of tags or reseller price.
  • Replacing a whole record. Crayon updates customer tenants, users, consumers, accounts, invoice profiles, groupings, assets and subscriptions with a full replace, so a field left out of the request can be cleared. The safe pattern is to read the record, change it and send all of it back, and each tool says so. Setting a subscription's tags works the same way: Crayon replaces the whole tag set, so every tag you leave out is cleared.
  • Granting access or storing a password: creating or changing a Cloud-iQ user (which can make a Tenant administrator), changing which organizations a user can reach, changing a user's password, and adding or updating a customer tenant with an administrator login.
  • A route whose effect Crayon does not document. Crayon publishes no description of its reserved-instance route, so the tool that writes to it is marked too, and its read twin says the meaning of the answer is unverified.
  • Recording a legal consent to a publisher agreement on a customer's behalf. Only do that with the customer's real consent.

Customer tenant answers can contain a password

Crayon's examples for creating, reading in detail, updating and adding an existing customer tenant all show the tenant administrator's user name and password in the answer. StackJack marks those tools as carrying credentials: it never saves their answers and never turns a large one into a stored file, but the values still appear in your AI conversation. Keep them out of tickets and chat. The API user's own profile read also echoes the access token it signed in with, and is marked the same way.

Billing statement files, reconciliation files, the billing records file, export files and the product price-list workbook are not returned as bytes. StackJack stores the file and gives your AI a read-only link that works for thirty minutes, along with the file's name and size. Open it promptly: after that the link stops working and the file has to be fetched again. If a StackJack deployment has no file storage configured, these tools fail with a clear message rather than handing back a link that would not work.

The monthly Azure usage tool answers differently: Crayon itself returns a storage link, also valid for thirty minutes, to the usage CSV. That link works for anyone who holds it, so open it promptly and do not paste it into tickets or chat.

Three usage-cost routes are not in Crayon's API description

Crayon's developer guide documents three usage-cost reads that its published API description leaves out. StackJack includes them next to the documented ones, and each says which documented tool answers the same question.

Lists, pages and what Crayon returns

Crayon numbers pages from one and lets you set a page size. It publishes no maximum, so StackJack caps the page size so one call cannot pull an unbounded amount out of a partner tenant: ask for the next page rather than a bigger one. Crayon's guide shows a list as an object holding the items and a total, while its API description says a plain array, and StackJack has no sandbox to settle it, so every answer is returned exactly as Crayon sends it.

Plans and limits

Read tools are available on the Free tier. Everything that creates, changes, deletes or administers is Pro. Business reaches the same tools as Pro and differs by monthly call quota.

See the generated Crayon tool reference for the current inventory, plan assignment, input schemas and destructive-action labels.

Crayon publishes no rate limit, so StackJack paces requests conservatively and backs off on its own if Crayon answers that it is being throttled. Pacing smooths a burst; it does not guarantee that every call arrives, so narrow a very wide read (fewer customers, a shorter date window) rather than repeating it.

Several customers and several tenants

One connection reaches every customer your Cloud-iQ tenant manages, so most partners need only one. Tools that act on a customer take an organization or customer tenant argument, and your AI finds those with the organizations and customer tenants tools first. A second connection is only for a partner that holds accounts with more than one Crayon tenant: add one per tenant from the connector's card, name it after the tenant, and your AI names it on each call. Omit the name and the call runs against your default connection. Pin an endpoint to one connection when an AI should never reach past a single tenant. See Several connections of one connector.

Troubleshooting

"Crayon refused the sign-in StackJack uses": one of the four values was not accepted. Re-enter all four on the Configure dialog: the Client ID and Client Secret from Cloud-iQ Clients, and the API user's user name and password from Cloud-iQ Users. Check that the user can sign in to Cloud-iQ itself, is not locked out after wrong passwords, has no multi-factor prompt and has not had its password changed.

"Crayon accepted the sign-in but refused this action": the connection works, but the API user's role or organization access may not cover that action. Crayon does not document which role each action needs, so check the API user's role under Users in Cloud-iQ, and check it has access to the organization involved. The organization access tool shows what the API user has today.

"Crayon could not find that record": check the ID against the matching list tool and pass it exactly as returned. The same answer appears when the API user has no access to the organization that owns the record.

"Crayon rejected the request as invalid": Crayon's answer names the problem in its message and error fields. Correct what it names and send the request again; repeating the identical call fails the same way. For a write that replaces a whole record, read the record first and send every field back.

A connection test passes but a tool fails on a customer: the test checks that the API user can sign in and open the list of organizations. It does not prove access to every organization, so a customer outside the user's organization access answers as not found or refused.

Something answered, but not Crayon: a proxy, firewall or sign-in page replied instead. StackJack reports that as a failure rather than as success, so a connection test cannot pass against a login screen. Try again in a moment, and check that Crayon's API is reachable from the internet.

Crayon tools

crayon_ · 158 tools · Free 99 · Pro 59

Activity and health

ToolWhat it does
crayon_get_current_user
Free · Read-only
Get the API user's own profile (user id, user name and claims).
crayon_list_activity_logs
Free · Read-only
List Cloud-iQ activity log entries (who changed what), filtered by entity, ids and a date range.
crayon_list_blog_items
Free · Read-only
List items from Crayon's blog feed (marketing news; no customer data).
crayon_ping
Free · Read-only
Check that Crayon's API is up and read its version fields (Date, Environment, AssemblyVersion, SdkVersion).
ToolWhat it does
crayon_consent_customer_tenant_agreement
Pro · Destructive
RECORDS a customer's consent to a publisher agreement (for example the Microsoft Customer Agreement) on the customer's behalf, naming the signer (firstName, lastName, email, optional phoneNumber, dateAgreed and agreementType).
crayon_list_customer_tenant_agreements
Free · Read-only
List the end-customer agreements a customer tenant has consented to (for example the Microsoft Customer Agreement).

Consumers and cloud accounts

ToolWhat it does
crayon_create_consumer
Pro · Write
Create a consumer record from a Consumer body.
crayon_create_crayon_account
Pro · Write
Create a Crayon account record from a CrayonAccount body.
crayon_delete_consumer
Pro · Destructive
Delete a consumer record by id.
crayon_get_aws_account
Free · Read-only
Get one AWS account record by id.
crayon_get_consumer
Free · Read-only
Get one consumer record by id.
crayon_get_crayon_account
Free · Read-only
Get one Crayon account record by id.
crayon_list_aws_accounts
Free · Read-only
List AWS account records, filtered by organization, publisher, consumer, tenant type and search text.
crayon_list_consumers
Free · Read-only
List consumer records attached to an organization, filtered by organization and search text.
crayon_list_crayon_accounts
Free · Read-only
List Crayon account records, filtered by organization, publisher, consumer, tenant type and search text.
crayon_update_aws_account
Pro · Destructive
Update an AWS account record from a whole AwsAccount body.
crayon_update_consumer
Pro · Destructive
Update a consumer record from a whole Consumer body.
crayon_update_crayon_account
Pro · Destructive
Update a Crayon account record from a whole CrayonAccount body.

Customer tenants

ToolWhat it does
crayon_add_existing_customer_tenant
Pro · Destructive
Add a customer tenant that already has subscriptions at the publisher but is not visible in Cloud-iQ.
crayon_create_customer_tenant
Pro · Destructive
PROVISIONS a new billable end-customer tenant at the publisher (for Microsoft, a new customer tenant under the partner) that purchases are then billed under (it spends money), which cannot be undone through this API.
crayon_delete_customer_tenant
Pro · Destructive
Delete a customer tenant by id.
crayon_get_customer_tenant
Free · Read-only
Get one customer tenant by id (summary view).
crayon_get_customer_tenant_azure_plan
Free · Read-only
Get the Azure Plan connected to a customer tenant (a tenant has at most one).
crayon_get_customer_tenant_detailed
Free · Read-only
Get one customer tenant with its contact, address and company profile.
crayon_list_customer_tenants
Free · Read-only
List end-customer tenants (the partner's customers, each tied to one publisher such as Microsoft), filtered by organization, publisher, program, consumer, domain, tenant type, invoice profile or search text.
crayon_update_customer_tenant
Pro · Destructive
Update a customer tenant from a whole CustomerTenantDetailed body.

Organizations

ToolWhat it does
crayon_check_organization_access
Free · Read-only
Check whether the API user can access an organization.
crayon_get_organization
Free · Read-only
Get one organization by id, including its parent organization, Crayon company name and account number.
crayon_get_organization_address
Free · Read-only
Get one invoice or delivery address of an organization by its address id.
crayon_get_organization_sales_contact
Free · Read-only
Get the Crayon sales contact assigned to an organization.
crayon_list_organization_addresses
Free · Read-only
List the invoice and delivery addresses stored for an organization.
crayon_list_organizations
Free · Read-only
List the organizations (the partner's own company and its customer companies) the Cloud-iQ API user can see, filtered by search text.

Users and access

ToolWhat it does
crayon_change_user_password
Pro · Destructive
Change a Cloud-iQ user's password.
crayon_create_user
Pro · Destructive
Create a Cloud-iQ user.
crayon_delete_user
Pro · Destructive
Delete a Cloud-iQ user by id.
crayon_get_user
Free · Read-only
Get one Cloud-iQ user by id (the id is a string).
crayon_get_user_by_username
Free · Read-only
Get one Cloud-iQ user by user name.
crayon_list_organization_access
Free · Read-only
List which organizations a Cloud-iQ user can access and with what role.
crayon_list_organization_access_grants
Free · Read-only
List organization access that can be granted to a user (Crayon's organizationaccess/grant route).
crayon_list_users
Free · Read-only
List Cloud-iQ users, filtered by search text, organization or role.
crayon_update_organization_access
Pro · Destructive
Replace the organization access of one or more Cloud-iQ users (which organizations each can reach and with what role).
crayon_update_user
Pro · Destructive
Update a Cloud-iQ user from a full UserUpsert body.

Assets

ToolWhat it does
crayon_add_asset_tags
Pro · Write
Add tags to an asset (costCenter, department, project, owner, custom).
crayon_delete_asset_tags
Pro · Destructive
Delete an asset's tags.
crayon_get_asset
Free · Read-only
Get one asset by id, with its order and billing details.
crayon_list_asset_orders
Free · Read-only
List assets grouped as orders (Crayon's assets/orders route; it takes the same filters as crayon_list_assets).
crayon_list_assets
Free · Read-only
List assets (software and reserved-instance purchase records), filtered by customer, publisher, external order ids, reservation id, asset type, status, search text and sorting.
crayon_replace_asset_tags
Pro · Destructive
Replace an asset's tags with the AssetTags body.
crayon_update_asset
Pro · Destructive
CHANGES an asset from a whole Asset body, and the Asset carries status, quantity, autoRenewEnabled and salesPrice, so a wrong body changes billing.

Azure Plans

ToolWhat it does
crayon_assign_azure_subscription_admin
Pro · Destructive
GRANTS an administrator on a live Azure subscription: the body names adminEmail.
crayon_cancel_azure_subscription
Pro · Destructive
CANCELS a live Azure subscription, ending the service.
crayon_create_azure_subscription
Pro · Destructive
CREATES an additional billable Azure subscription under a customer's Azure Plan.
crayon_enable_azure_subscription
Pro · Destructive
RE-ENABLES a cancelled Azure subscription, so billing resumes.
crayon_get_azure_plan
Free · Read-only
Get one Azure Plan by id (a customer tenant has at most one; crayon_get_customer_tenant_azure_plan finds it).
crayon_get_azure_subscription
Free · Read-only
Get one Azure subscription (entitlement) under an Azure Plan.
crayon_list_azure_subscriptions
Free · Read-only
List the Azure subscriptions (entitlements) under an Azure Plan, filtered by search text.
crayon_rename_azure_subscription
Pro · Write
Rename an Azure subscription (the body carries name).
crayon_update_azure_subscription
Pro · Destructive
Update an Azure subscription's invoice profile and tags from a PutAzureSubscription body.

Azure usage

ToolWhat it does
crayon_get_azure_monthly_usage
Free · Read-only
Get a month's Azure usage for one Azure subscription.
ToolWhat it does
crayon_list_management_links
Free · Read-only
List links to the publisher portals where subscriptions are managed, filtered by subscription ids and customer (reseller customer) ids.
crayon_list_management_links_grouped
Free · Read-only
List the same management links, distinct and grouped by customer (reseller customer).

New Commerce orders

ToolWhat it does
crayon_create_new_commerce_order
Pro · Destructive
PURCHASES a Microsoft New Commerce (NCE) subscription for a customer tenant and bills it; it combines Crayon's verify and checkout steps in one call.
crayon_get_new_commerce_order
Free · Read-only
Get the subscription id or ids created by a New Commerce order, from the NewCommerceOrderId crayon_create_new_commerce_order returned.

Subscription changes

ToolWhat it does
crayon_add_subscription_addon
Pro · Destructive
PURCHASES an add-on onto a live subscription and bills it.
crayon_convert_subscription
Pro · Destructive
CONVERTS a subscription to another offer, which changes the product and billing the customer is on.
crayon_delete_subscription_tags
Pro · Destructive
Delete a subscription's tags.
crayon_get_subscription_tags
Free · Read-only
Get a subscription's tags (cost center, department, project, owner and a custom field).
crayon_list_subscription_addon_offers
Free · Read-only
List the add-on offers available for a subscription.
crayon_list_subscription_conversions
Free · Read-only
List the offers a subscription can be converted to.
crayon_list_subscription_term_change_options
Free · Read-only
List the term durations and billing cycles a subscription can be changed to immediately.
crayon_list_subscription_transition_eligibilities
Free · Read-only
List the upgrade (transition) targets a subscription is eligible for; eligibilityType selects the kind of transition.
crayon_list_subscription_transitions
Free · Read-only
List the upgrades (transitions) already made for a subscription.
crayon_set_subscription_next_term
Pro · Destructive
SCHEDULES what a subscription renews into at its next term (part number, billing cycle, term, quantity), which changes the renewal bill.
crayon_set_subscription_tags
Pro · Destructive
REPLACES a subscription's whole tag set (costCenter, department, project, owner, custom).
crayon_transition_subscription
Pro · Destructive
UPGRADES a subscription to another product or quantity, which changes what the customer is billed.

Subscriptions

ToolWhat it does
crayon_create_subscription
Pro · Destructive
PURCHASES a new subscription for a customer tenant and bills it from now (this route also provisions an Azure Plan).
crayon_get_coterminosity
Free · Read-only
List the coterminosity dates available for a customer tenant's Microsoft NCE subscriptions: the end dates a new or renewed seat subscription can be aligned to.
crayon_get_coterminosity_deprecated
Free · Read-only
DEPRECATED by Crayon (its guide calls the v1 route obsolete and says it will be removed): use crayon_get_coterminosity, which answers the same question.
crayon_get_subscription
Free · Read-only
Get one subscription by id, with its quantity, status, renewal and term details.
crayon_get_subscription_activation_link
Free · Read-only
Get the activation link of a subscription (a publisher URL used to activate it).
crayon_get_subscription_price
Free · Read-only
Get the current unit price of a Microsoft CSP subscription.
crayon_get_subscription_reserved_instance
Free · Read-only
Reads Crayon's reserved-instance answer for one subscription: a list of booleans for a subscription id and a true or false reservedInstance path value.
crayon_list_subscription_price_types
Free · Read-only
List the subscription price types Crayon knows.
crayon_list_subscriptions
Free · Read-only
List subscriptions (licences and cloud services) across the partner's customers, filtered by organization, customer tenant, publisher, status flags, trial flag and search text.
crayon_set_subscription_reserved_instance
Pro · Destructive
CALLS Crayon's undocumented reserved-instance route for one subscription with a true or false reservedInstance path value, and answers one boolean.
crayon_update_subscription
Pro · Destructive
CHANGES a live subscription's quantity, status or renewal settings, which changes what the customer is billed (for example suspending it or cutting seats).

Billing statements

ToolWhat it does
crayon_download_billing_statement_file
Free · Read-only
Download a billing statement's Excel file (Crayon's download route).
crayon_get_billing_reconciliation_file
Free · Read-only
Get a billing statement's reconciliation CSV (a zip when Crayon splits it).
crayon_get_billing_reconciliation_file_v2
Free · Read-only
Get the v2 reconciliation CSV of a billing statement: detailed daily Azure Plan usage billing data (Crayon marks v2 as an initial beta).
crayon_get_billing_records_file
Free · Read-only
Get a billing statement's billing records as a JSON file (a zip when Crayon splits it).
crayon_get_billing_statement_file
Free · Read-only
Get a billing statement as an Excel file (a zip when Crayon splits it).
crayon_list_billing_statements
Free · Read-only
List billing statements (the partner's monthly bills from Crayon), filtered by invoice profile, organization, provision type and a date range.
crayon_list_billing_statements_grouped
Free · Read-only
List billing statements grouped per bill, with the same filters as crayon_list_billing_statements.

Catalog

ToolWhat it does
crayon_export_agreement_products_file
Free · Read-only
Export the filtered agreement products as an Excel workbook (the body is the same AgreementProductFilter as crayon_search_agreement_products).
crayon_get_agreement_reports
Free · Read-only
List the agreement reports (usage reporting) of a product container.
crayon_get_csp_billing_cycle_names
Free · Read-only
Get the dictionary that maps Microsoft CSP billing cycle names to Crayon's.
crayon_get_program
Free · Read-only
Get one program by id.
crayon_get_publisher
Free · Read-only
Get one publisher by id.
crayon_get_region_by_code
Free · Read-only
Get one region by its code.
crayon_list_agreement_products
Free · Read-only
List the products a partner can buy under its agreements (the price list), filtered by agreement, price list, organization, customer tenant, trial flag and search text, and by the Include.* and Exclude.* product attributes (part numbers, publishers, programs, billing cycles and more).
crayon_list_agreements
Free · Read-only
List agreements (the contracts a partner buys under), filtered by organization, price list, status, agreement type, publisher and program.
crayon_list_billing_cycles
Free · Read-only
List the billing cycles Crayon supports (set includeUnknown to include the Unknown value).
crayon_list_product_billing_cycles
Free · Read-only
List the billing cycles a product (by part number) supports, optionally for one customer (resellerCustomerId).
crayon_list_product_variant_billing_cycles
Free · Read-only
List the billing cycles a product variant supports.
crayon_list_programs
Free · Read-only
List programs (a publisher's licensing programs), filtered by publisher, program type, organization and search text.
crayon_list_publishers
Free · Read-only
List publishers (Microsoft, Adobe, Google, AWS and others), filtered by names, search text and program type.
crayon_list_regions
Free · Read-only
List regions, filtered by region list, organization and search text.
crayon_search_agreement_products
Free · Read-only
Search the agreement products with a filter body (AgreementProductFilter).
crayon_update_agreement_report
Pro · Destructive
CHANGES an agreement report from a whole AgreementReport body.

Exports

ToolWhat it does
crayon_delete_export
Pro · Destructive
Delete an export file from the queue.
crayon_download_export
Free · Read-only
Download a generated export file (Crayon says it is a zip holding the Excel file).
crayon_generate_license_report_export
Pro · Write
Queue a Microsoft NCE license-based usage report (CSV) for a customer account; it appears in the export queue and in Cloud-iQ.
crayon_list_exports
Free · Read-only
List the export queue (custom export files Crayon has generated or is generating).

Invoicing

ToolWhat it does
crayon_create_grouping
Pro · Write
Create a grouping from a Grouping body (name, invoiceProfile and organization references).
crayon_create_invoice_profile
Pro · Write
Create an invoice profile from an InvoiceProfile body (organization, name, invoice address id and delivery address).
crayon_delete_grouping
Pro · Destructive
Delete a grouping by id.
crayon_delete_invoice_profile
Pro · Destructive
Delete an invoice profile by id.
crayon_get_grouping
Free · Read-only
Get one grouping by id.
crayon_get_invoice_profile
Free · Read-only
Get one invoice profile by id.
crayon_list_groupings
Free · Read-only
List groupings (invoice groupings of an organization), filtered by organization, search text and whether removed ones are included.
crayon_list_invoice_profiles
Free · Read-only
List invoice profiles (how and where an organization is invoiced), filtered by organization and search text.
crayon_list_invoices
Free · Read-only
List the invoices of an organization.
crayon_update_grouping
Pro · Destructive
Update a grouping from a whole Grouping body.
crayon_update_invoice_profile
Pro · Destructive
Update an invoice profile from a whole InvoiceProfile body.

Ordering

ToolWhat it does
crayon_cancel_scheduled_order
Pro · Destructive
CANCELS a scheduled order (identified by its objectReferenceId and order number) before it is processed.
crayon_checkout_facebook_order
Pro · Destructive
PLACES a Facebook order and bills it.
crayon_checkout_google_order
Pro · Destructive
PLACES a Google order and bills it.
crayon_checkout_order_legacy
Pro · Destructive
PLACES an order and bills it, exactly as crayon_checkout_purchase_request does; this is Crayon's LEGACY URL for the same call, kept for backward compatibility, so prefer crayon_checkout_purchase_request.
crayon_checkout_purchase_request
Pro · Destructive
PLACES an order and bills it: it checks out a PurchaseRequestOrder for a customer (resellerCustomerId, orderLines with productId, productVariantId, quantity, billingCycle, termDuration and type, optional scheduledPurchaseDate).
crayon_list_order_items
Free · Read-only
List the line items of an invoiced order (orderId is a number; organizationId is required).
crayon_list_order_items_v2
Free · Read-only
List the line items of an invoiced order, v2 (orderId is a string; organizationId is required).
crayon_list_purchase_orders
Free · Read-only
List processed purchase orders for a customer tenant, filtered by order state, search text and sorting.
crayon_list_scheduled_orders
Free · Read-only
List scheduled purchase requests (orders set to process on a later date), filtered by customer.
crayon_verify_order_legacy
Free · Read-only
LEGACY URL of crayon_verify_purchase_request, kept by Crayon for backward compatibility: prefer crayon_verify_purchase_request.
crayon_verify_purchase_request
Free · Read-only
VERIFY an order before checkout: it validates a PurchaseRequestOrder (resellerCustomerId and orderLines with productId, productVariantId, quantity, billingCycle, termDuration and type) and places nothing.

Product containers

ToolWhat it does
crayon_create_or_get_shopping_cart
Pro · Write
Get the organization's shopping cart, CREATING one if none exists.
crayon_create_product_container_report
Pro · Write
Create a monthly product container report for an organization and program (set copyLast to copy the previous month's rows).
crayon_delete_product_container
Pro · Destructive
Delete a product container by id.
crayon_get_product_container
Free · Read-only
Get one product container by id.
crayon_get_product_container_row_issues
Free · Read-only
Get a product container with the issues found on its rows.
crayon_list_product_containers
Free · Read-only
List product containers (shopping carts and monthly usage reports), filtered by organization, type, category, program, year, month, user and draft state.
crayon_update_product_container
Pro · Destructive
CHANGES a product container from a whole ProductContainer body.
crayon_update_product_container_row
Pro · Write
Change one row of a product container (the ProductRowPatch body can set quantity, comment, usageCountryCode, userId and references).

Reseller prices

ToolWhat it does
crayon_create_reseller_sales_price
Pro · Destructive
SETS a new reseller sales price: the price the partner charges its customers for an object from a fromDate.
crayon_delete_reseller_sales_price
Pro · Destructive
DELETES a reseller sales price (identified by type, objectId, objectType and fromDate), which changes what the partner charges its customers.
crayon_get_current_reseller_sales_price
Free · Read-only
Get the reseller sales price currently in force for an object (type, objectId, objectType and an optional fromDate).
crayon_list_reseller_sales_prices
Free · Read-only
List the reseller sales prices (what the partner charges its own customers), filtered by price type, object id, object type and from date.
crayon_toggle_reseller_sales_price
Pro · Destructive
SWITCHES reseller sales pricing on or off for an object (the body carries toggle, objectId and objectType), which changes what the partner charges its customers.
crayon_update_reseller_sales_price
Pro · Destructive
CHANGES a reseller sales price (the one whose fromDate is oldFromDate) to the ResellerSalesPrice body, which changes what the partner charges its customers.

Usage cost

ToolWhat it does
crayon_get_category_usage_cost
Free · Read-only
Get the usage cost of one subscription broken down to a category.
crayon_get_organization_usage_cost
Free · Read-only
Get an organization's usage cost over a date range (from and to are required).
crayon_get_reseller_customer_usage_cost
Free · Read-only
Get the usage cost of one subscription of a customer tenant (resellerCustomerId) in a currency over a date range.
crayon_get_reseller_customer_usage_cost_by_category
Free · Read-only
Get the usage cost of one subscription of a customer tenant for one category in a currency over a date range.
crayon_get_reseller_customer_usage_cost_by_subcategory
Free · Read-only
Get the usage cost of one subscription of a customer tenant for one category and sub category in a currency over a date range.
crayon_get_resource_group_usage_cost
Free · Read-only
Get the usage cost of one resource group.
crayon_get_subcategory_usage_cost
Free · Read-only
Get the usage cost of one subscription broken down to a sub category.
crayon_get_subscription_resource_groups_usage_cost
Free · Read-only
Get the usage cost of one subscription per resource group.
crayon_get_subscription_usage_cost
Free · Read-only
Get the usage cost of one subscription over a date range.