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 1 month 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. Crayon also still runs the older PRISM portal (formerly rhipe PRISM). The same Crayon connection can connect to PRISM as well: connect Cloud-iQ, PRISM or both, each with its own credentials.

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
  • Work in PRISM (optional, for accounts that still run on it): your customers, users and contacts, Microsoft CSP tenants and subscriptions, Azure and consumption programs, agreements and programs, price lists, invoices and usage reporting. The PRISM tools start with crayon_prism_ and appear once the PRISM credentials are saved
  • 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

For Cloud-iQ, Crayon signs a partner integration in with two things at once, and StackJack needs all four values (PRISM has its own, separate pair: see Connect PRISM below):

  • 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 in the Cloud-iQ section. There is no address to enter: Crayon's API address is fixed. If you only use PRISM, leave the Cloud-iQ section empty and go to Connect PRISM below.
  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. The dialog shows the values that are not secret (the Client IDs, the API user's name, the default organization ID and the PRISM Customer ID) and starts every secret box blank: a blank secret box keeps the stored secret, so adding PRISM to a working Cloud-iQ connection does not ask you to retype the Cloud-iQ secrets. Each section is all or nothing, and at least one section has to be complete. An empty default organization ID or PRISM Customer ID removes that default. To take a whole section away, tick its Remove the stored credentials box; emptying a stored section's boxes does not remove it, and StackJack refuses a save that blanks them without that tick. StackJack also refuses a removal that would leave no section at all. 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.

Connect PRISM (optional)

Use this section if your Crayon account still runs on the PRISM portal (formerly rhipe PRISM). Cloud-iQ and PRISM are separate: you can connect either one, or both, on the same Crayon connection.

  1. Sign in to the PRISM portal as an administrator of your company.
  2. Open Customer Management and click View on your own company (the first row).
  3. On Customer Details, click Manage Client Credentials, then Generate Client Credentials.
  4. Copy the Client ID and the Client Secret. Store the secret safely; PRISM shows it when it is generated.
  5. In StackJack, open Connectors, choose Crayon, then Configure, go to the PRISM section, paste both values and save. If you use only PRISM, leave the Cloud-iQ section empty.
  6. Optional: paste your company's PRISM Customer ID (shown on Customer Details). Tools that need your customer ID use it by default.
  7. Click Test connection. StackJack checks each section you filled in.

The PRISM tools start with crayon_prism_. The credentials act as your whole company: every customer, tenant and subscription under you. Order, quantity, suspend, cancel and renew actions bill your account and are marked destructive. Most of them run asynchronously; the answer includes a task reference that crayon_prism_get_long_running_task follows. If you resell through sub-resellers, the actAsCustomerId argument acts as one of them.

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.

PRISM actions work the same way, and most run in the background

PRISM has no sandbox either. Placing an order for Microsoft subscriptions, an Azure subscription or a reservation, changing a quantity, suspending, resuming, cancelling or renewing a subscription, submitting a usage report, moving a tenant to another customer, setting a customer's prices or direct debit details, and creating or deactivating customers, users and tenants all buy something or change what is billed, so they need the Pro tier and are marked for confirmation. Microsoft's New Commerce rules apply: a suspended subscription is still billed, and a quantity decrease or a cancellation only works inside the cancellation window shown on the subscription.

Most PRISM actions finish in the background. PRISM answers with a task reference straight away, and the long running task tool shows whether the work finished. While a provisioning job is running it can lock the subscription or tenant, and a second request is refused until the job ends: wait and try again. Reading and listing tools are Free.

PRISM is being retired by Crayon in favor of Cloud-iQ, and Crayon has published no end date. When PRISM goes, its tools answer whatever PRISM answers, and the PRISM section can be removed without touching the Cloud-iQ section. One caution while both are connected: the connection has a single on/off state, so a PRISM pair that PRISM keeps rejecting can switch off the whole connection after three failed checks, Cloud-iQ included. Remove the PRISM section or paste a new pair to fix it.

PRISM tools that take a customer ID use your stored PRISM Customer ID when your AI does not name one, and the word me otherwise, which PRISM accepts on some routes only. If a call says it could not find a record, store your company's PRISM Customer ID in the PRISM section.

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, the product price-list workbook and, in PRISM, invoice documents, price-list exports and legal documents 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.

"PRISM refused the PRISM client credentials": the Client ID and Client Secret were not accepted. Generate a new pair in the PRISM portal (Customer Management, View on your own company, Customer Details, Manage Client Credentials, Generate Client Credentials), then paste both into the PRISM section. PRISM shows the secret when it is generated, so copy it straight away. The Cloud-iQ section of the same connection is not affected.

"PRISM accepted the sign-in but this client cannot reach that customer, program or action": the PRISM client acts as the company it was generated for. Check the customer ID your AI passed, and the acting customer ID if you resell through sub-resellers.

"PRISM could not find that record": check the ID against the matching list tool and pass it exactly as returned. If the call named no customer, store your company's PRISM Customer ID in the PRISM section, because the word me is accepted on some PRISM routes only.

"PRISM rejected the request as invalid": PRISM's answer names the problem. Correct what it names and send the request again; repeating the identical call fails the same way.

"PRISM is rate limiting StackJack": PRISM publishes no limit, so wait a moment and narrow the read (a smaller page or fewer customers) rather than repeating it.

"PRISM refused the request because the record is locked or the name is taken": a provisioning job is running on that subscription or tenant, so try again when it ends (the long running task tool shows when). For a new Azure subscription, the same answer means the name is already taken.

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_ · 405 tools · Free 253 · Pro 152

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.

PRISM Account

ToolWhat it does
crayon_prism_accept_legal_document
Pro · Destructive
Accept a legal document on the customer's behalf.
crayon_prism_accept_terms_of_trade
Pro · Destructive
Accept PRISM's terms of trade for the customer.
crayon_prism_check_terms_of_trade_required
Free · Read-only
Check if the customer need to accept the terms of trade.
crayon_prism_download_legal_document
Free · Read-only
Download a legal document as a PDF.
crayon_prism_global_search
Free · Read-only
Search PRISM for items by text (page with skip and take).
crayon_prism_list_legal_document_acknowledgements
Free · Read-only
Get the legal documents that has acknowledged as accepted.

PRISM Customers

ToolWhat it does
crayon_prism_add_customer_contact
Pro · Write
Add a contact to a PRISM customer.
crayon_prism_check_customer_active
Free · Read-only
Check if a customer is active.
crayon_prism_check_customer_can_be_deactivated
Free · Read-only
Check whether or not a customer can be deactivate.
crayon_prism_check_customer_has_transitioning_tenant
Free · Read-only
Check whether the end customers has transitioning tenant.
crayon_prism_create_billing_details_update_link
Pro · Write
Generate a link a child customer opens to update its billing details.
crayon_prism_create_customer
Pro · Write
Create a new PRISM customer (crayon_prism_validate_new_customer checks the details first).
crayon_prism_deactivate_customer
Pro · Destructive
Deactivate a PRISM customer (crayon_prism_check_customer_can_be_deactivated says whether it can be).
crayon_prism_delete_customer_contact
Pro · Destructive
Delete a contact of a PRISM customer.
crayon_prism_delete_payment_method
Pro · Destructive
Delete a stored payment method of a customer.
crayon_prism_email_billing_details_update_link
Pro · Write
Email a billing details update link to a child customer.
crayon_prism_get_child_customer
Free · Read-only
Lists the details of this customer.
crayon_prism_get_customer
Free · Read-only
Get the details of a PRISM customer (v1; the v2 API has no get-by-id).
crayon_prism_get_direct_debit_restrictions
Free · Read-only
Get the direct debit restrictions for a customer.
crayon_prism_list_customer_contacts
Free · Read-only
Get the contacts associated with a PRISM customer.
crayon_prism_list_customers
Free · Read-only
Returns paginated list of customers.
crayon_prism_list_customers_not_in_program
Free · Read-only
List customers not in a program.
crayon_prism_reactivate_customer
Pro · Destructive
Reactivate a deactivated PRISM customer; its services and billing resume.
crayon_prism_search_customer_descendants
Free · Read-only
Search descendant children of a given customer.
crayon_prism_search_customers
Free · Read-only
Search customers.
crayon_prism_set_direct_debit_details
Pro · Destructive
Set the bank account (account number and BSB) PRISM direct-debits a customer's invoices from, replacing the details on file.
crayon_prism_sync_customer_contacts
Pro · Destructive
Replace the whole set of contacts of a PRISM customer with the set sent.
crayon_prism_update_customer
Pro · Write
Update the details of a PRISM customer.
crayon_prism_validate_new_customer
Free · Read-only
Check a new customer's details (address included) before creating it.

PRISM Reports and audit

ToolWhat it does
crayon_prism_get_audit_history
Free · Read-only
Get the audit records of an entity (the request.* arguments are PRISM's request model).
crayon_prism_get_csp_agreements_report
Free · Read-only
Get a report of the Microsoft agreements across the partner's Microsoft CSP tenants.
crayon_prism_get_customer_report_embed_link
Free · Read-only
Get the embed link for one of a customer's reports.
crayon_prism_get_tenant_report_embed_link
Free · Read-only
Get the embed link for one of a tenant's reports.
crayon_prism_list_audit_history_page
Free · Read-only
Retrieve a page of audit records for an entity (the request.* arguments are PRISM's request model).
crayon_prism_list_customer_reports
Free · Read-only
Getting all available customer reports.
crayon_prism_list_order_audit_history
Free · Read-only
Retrieve a page of audit records for a tenant's orders.
crayon_prism_list_subscription_audit_history
Free · Read-only
Retrieve a page of audit records for a tenant's subscription.
crayon_prism_list_tenant_audit_history
Free · Read-only
Retrieve a page of audit records for a tenant.
crayon_prism_list_tenant_reports
Free · Read-only
Getting all available tenant reports.

PRISM Users

ToolWhat it does
crayon_prism_activate_user
Pro · Destructive
Activate a deactivated user account.
crayon_prism_create_customer_user
Pro · Destructive
Create a portal user for a customer.
crayon_prism_deactivate_user
Pro · Destructive
Deactivate a user account.
crayon_prism_get_my_profile
Free · Read-only
Get the profile of the user the PRISM credentials act as.
crayon_prism_get_user_profile
Free · Read-only
Returns the profile information for requested user.
crayon_prism_list_customer_users
Free · Read-only
Lists all users belonging to a given customer.
crayon_prism_list_user_roles
Free · Read-only
Gets a list of available user roles for a customer user.
crayon_prism_reset_user_mfa
Pro · Destructive
Reset a user's multi-factor setup so they must configure it again.
crayon_prism_reset_user_password
Pro · Destructive
Reset the password of a PRISM user.
crayon_prism_search_my_customers
Free · Read-only
Search for my customers.
crayon_prism_set_user_roles
Pro · Destructive
Change the roles of a customer user.
crayon_prism_update_user_profile
Pro · Write
Update the basic profile information of a user.

PRISM Validation

ToolWhat it does
crayon_prism_get_country
Free · Read-only
Get country details.
crayon_prism_list_address_countries
Free · Read-only
Get a list of countries for program.
crayon_prism_list_partner_center_countries
Free · Read-only
Get a list of valid countries from partner center.
crayon_prism_validate_address
Free · Read-only
Address validation.
crayon_prism_validate_agreement_number
Free · Read-only
Check an agreement number's validity.
crayon_prism_validate_csp_domain_prefix
Free · Read-only
Validate a domain prefix for the creation of a new Microsoft CSP Tenant.
crayon_prism_validate_mpn_id
Free · Read-only
Validate the mpn with Microsoft Partner Center.

PRISM Consumption programs

ToolWhat it does
crayon_prism_create_consumption_addon_order
Pro · Destructive
Order an add-on subscription for a consumption subscription; the add-on is billed to the partner (asynchronous: PRISM answers 202 with a longRunningTaskRef and the work finishes in the background, so crayon_prism_get_long_running_task reports the outcome).
crayon_prism_create_consumption_order
Pro · Destructive
Place an order that creates a consumption tenant and buys its subscriptions; every subscription in the order is billed to the partner (asynchronous: PRISM answers 202 with a longRunningTaskRef and the work finishes in the background, so crayon_prism_get_long_running_task reports the outcome).
crayon_prism_create_consumption_tenant
Pro · Destructive
Create a consumption tenant together with its first order; the products ordered are billed to the partner.
crayon_prism_delete_consumption_tenant
Pro · Destructive
Delete a consumption tenant.
crayon_prism_get_consumption_subscription
Free · Read-only
Get the details of the specified subscription.
crayon_prism_get_consumption_subscription_estimated_spend
Free · Read-only
Get the estimated monthly spend for a subscription.
crayon_prism_get_consumption_tenant
Free · Read-only
Gets a single tenant.
crayon_prism_get_consumption_tenant_estimated_spend
Free · Read-only
Get the estimated monthly spend.
crayon_prism_get_consumption_tenant_usage
Free · Read-only
Returns all the recorded usage for a given tenant and date range.
crayon_prism_list_consumption_products_for_agreement
Free · Read-only
Get a list of any subscription products available to the contract agreement.
crayon_prism_list_consumption_products_for_tenant
Free · Read-only
Get a list of any subscription products available to the tenant.
crayon_prism_list_consumption_subscription_addons
Free · Read-only
Get the available addon products for a subscription.
crayon_prism_list_consumption_tenants
Free · Read-only
Get all tenants.
crayon_prism_resume_consumption_subscription
Pro · Destructive
Resume a suspended consumption subscription; its billing resumes (asynchronous: PRISM answers 202 with a longRunningTaskRef and the work finishes in the background, so crayon_prism_get_long_running_task reports the outcome).
crayon_prism_set_consumption_subscription_quantity
Pro · Destructive
Change the quantity of a consumption subscription, which changes what the partner is billed (asynchronous: PRISM answers 202 with a longRunningTaskRef and the work finishes in the background, so crayon_prism_get_long_running_task reports the outcome).
crayon_prism_suspend_consumption_subscription
Pro · Destructive
Suspend a consumption subscription (asynchronous: PRISM answers 202 with a longRunningTaskRef and the work finishes in the background, so crayon_prism_get_long_running_task reports the outcome).

PRISM Microsoft CSP tenants

ToolWhat it does
crayon_prism_approve_tenant_request
Pro · Destructive
Approve a pending tenant request (the PUT form without details).
crayon_prism_approve_tenant_request_with_details
Pro · Destructive
Approve a request to create or connect a Microsoft CSP tenant, sending the approval details (asynchronous: PRISM answers 202 with a longRunningTaskRef and the work finishes in the background, so crayon_prism_get_long_running_task reports the outcome).
crayon_prism_bulk_connect_csp_tenants
Pro · Destructive
Create or connect many Microsoft CSP tenants to a contract agreement in one call.
crayon_prism_check_program_customer_can_be_activated
Free · Read-only
Check whether or not a tenant can be activated.
crayon_prism_check_program_customer_can_be_deactivated
Free · Read-only
Check whether or not a tenant can be deactivated.
crayon_prism_check_tenant_agreement_on_hold
Free · Read-only
Check the on-hold state of the tenants contract agreement.
crayon_prism_check_tenant_customer_agreement
Free · Read-only
Check MCA for Microsoft CSP tenant and return most recent agreement date.
crayon_prism_check_tenant_sync_locks
Free · Read-only
verify whether the tenant has sync lock in place.
crayon_prism_create_csp_tenant
Pro · Destructive
Create a Microsoft CSP tenant for a PRISM customer (the body carries the customer's Microsoft Customer Agreement confirmation) (asynchronous: PRISM answers 202 with a longRunningTaskRef and the work finishes in the background, so crayon_prism_get_long_running_task reports the outcome).
crayon_prism_create_gdap_relationship
Pro · Destructive
Request a GDAP admin relationship for a customer tenant.
crayon_prism_create_transition_customer
Pro · Destructive
Create a PRISM customer for a transitioning Microsoft tenant, which starts a CSP transition of that tenant to this partner (asynchronous: PRISM answers 202 with a longRunningTaskRef and the work finishes in the background, so crayon_prism_get_long_running_task reports the outcome).
crayon_prism_deactivate_program_customer
Pro · Destructive
Deactivate a program customer (a customer's enrollment under a contract agreement).
crayon_prism_decline_tenant_request
Pro · Destructive
Decline a request to create or connect a Microsoft CSP tenant for a PRISM customer.
crayon_prism_delete_csp_tenant
Pro · Destructive
Delete a Microsoft CSP tenant.
crayon_prism_delete_tenant_transition
Pro · Destructive
Delete a tenant transition.
crayon_prism_get_csp_tenant
Free · Read-only
Get the details of a Microsoft CSP tenant.
crayon_prism_get_csp_tenant_estimated_pricing
Free · Read-only
Get the estimated pricing for existing and/or new subscriptions for a Microsoft CSP Tenant.
crayon_prism_get_csp_tenant_estimated_spend
Free · Read-only
Get the estimated monthly spend.
crayon_prism_get_partner_group_object
Free · Read-only
Gets the group object id for the partner to which the tenant belongs.
crayon_prism_get_transition_partner_connect_link
Pro · Write
Get the transition link to the Partner Connection website (a GET whose operationId says Send, so it is classified a write until proven a pure read).
crayon_prism_list_consumers
Free · Read-only
Get all consumers (also known as tenants).
crayon_prism_list_csp_tenant_accounts
Free · Read-only
Fetch customer tenant accounts.
crayon_prism_list_csp_tenant_available_products
Free · Read-only
List the products a Microsoft CSP tenant can order, with the partner's prices.
crayon_prism_list_csp_tenants
Free · Read-only
List the Microsoft CSP tenants of the caller's company (the paginated list; use page and pageSize).
crayon_prism_list_csp_tenants_for_customer_program
Free · Read-only
Get all Microsoft CSP tenants for the given partner customer Id and program Id.
crayon_prism_list_gdap_groups
Free · Read-only
Get all Gdap Groups.
crayon_prism_list_gdap_relationships
Free · Read-only
Get all the admin relationships for the specified tenant.
crayon_prism_list_product_qualifications
Free · Read-only
Get list of qualifications for the current Tenant.
crayon_prism_list_tenant_calendar_month_end_dates
Free · Read-only
Get calendar aligned month end dates of the specified tenantId.
crayon_prism_list_tenant_coterminous_end_dates
Free · Read-only
Get coterminosity end dates of the specified tenantId.
crayon_prism_list_tenant_customer_agreements
Free · Read-only
Get a list of Microsoft tenant customer agreements.
crayon_prism_list_tenant_related_program_products
Free · Read-only
List the related program products that are available to a tenant.
crayon_prism_list_tenant_support_plans
Free · Read-only
Get the available support plans for a tenant.
crayon_prism_move_tenant_to_customer
Pro · Destructive
Move a tenant to another PRISM customer, which changes who is billed for it.
crayon_prism_reactivate_program_customer
Pro · Destructive
Reactivate a deactivated program customer; its service and billing resume.
crayon_prism_resync_csp_tenant
Pro · Write
Resync a tenant with Microsoft (refreshes PRISM's data, changes nothing at Microsoft) (asynchronous: PRISM answers 202 with a longRunningTaskRef and the work finishes in the background, so crayon_prism_get_long_running_task reports the outcome).
crayon_prism_resync_transitioning_csp_tenant
Pro · Write
Resync a tenant that is in the Transitioning state with Microsoft (refreshes PRISM's data) (asynchronous: PRISM answers 202 with a longRunningTaskRef and the work finishes in the background, so crayon_prism_get_long_running_task reports the outcome).
crayon_prism_retry_csp_tenant_provisioning
Pro · Destructive
Retry the provisioning of a failed tenant.
crayon_prism_send_gdap_invitation_link
Pro · Destructive
Email a GDAP invitation link for a customer tenant.
crayon_prism_set_tenant_support_plan
Pro · Destructive
Set the active support plan of a tenant; the support plan is billed.
crayon_prism_terminate_gdap_relationship
Pro · Destructive
Terminate a GDAP admin relationship for a customer tenant.
crayon_prism_update_tenant_market_category
Pro · Write
Update the Microsoft market category recorded for a tenant (the vendor's summary says it updates the category) (asynchronous: PRISM answers 202 with a longRunningTaskRef and the work finishes in the background, so crayon_prism_get_long_running_task reports the outcome).
crayon_prism_validate_bulk_connect_csp_tenants
Free · Read-only
Bulk create Microsoft CSP Tenants validation.

PRISM Azure

ToolWhat it does
crayon_prism_check_azure_plan_upgrade_eligibility
Free · Read-only
Checking eligibility of tenant for upgrade.
crayon_prism_check_tenant_has_any_azure_subscription
Free · Read-only
Verifying tenant's current Azure subscriptions.
crayon_prism_check_tenant_has_azure_subscription
Free · Read-only
Verifying tenant's current subscriptions.
crayon_prism_create_azure_subscription_order
Pro · Destructive
Place an order for a new Azure subscription on a tenant; the subscription bills Azure usage to the partner (asynchronous: PRISM answers 202 with a longRunningTaskRef and the work finishes in the background, so crayon_prism_get_long_running_task reports the outcome).
crayon_prism_create_reserved_instance_order
Pro · Destructive
Place an Azure Reserved Instance order; a reservation is a prepaid commitment billed to the partner (asynchronous: PRISM answers 202 with a longRunningTaskRef and the work finishes in the background, so crayon_prism_get_long_running_task reports the outcome).
crayon_prism_delete_azure_spend_threshold
Pro · Destructive
Delete the monthly usage notification threshold of an Azure subscription.
crayon_prism_get_azure_monthly_usage_file_link
Free · Read-only
Get the link to a subscription's monthly Azure usage file.
crayon_prism_get_azure_plan_upgrade_status
Free · Read-only
Checking the current status of the upgrade to Azure plan.
crayon_prism_get_azure_spend_threshold
Free · Read-only
Gets existing (if any) Azure Target Monthly Usage notification threshold.
crayon_prism_get_azure_subscription_partner_role
Free · Read-only
Fetches the access level of the partner for the given azure subscription.
crayon_prism_get_azure_usage_for_period
Free · Read-only
Gets Azure usage for a period.
crayon_prism_get_azure_usage_spike_alert
Free · Read-only
Gets existing (if any) Azure Usage Spike.
crayon_prism_get_azure_usage_summary
Free · Read-only
Get the usage summary of a specified usage period for a specified Azure subscription.
crayon_prism_get_future_azure_spend_threshold
Free · Read-only
Get azure usage spend threshold set for future subscriptions.
crayon_prism_get_reserved_instance
Free · Read-only
Get the details of the specified reserved instance.
crayon_prism_list_azure_subscriptions
Free · Read-only
Get a list of Azure subscriptions.
crayon_prism_list_azure_usage_line_items
Free · Read-only
Get detailed usage line items for an Azure subscription.
crayon_prism_list_reserved_instance_products
Free · Read-only
Get a list of all Azure Reserved Instance products available to the Microsoft CSP tenant.
crayon_prism_list_reserved_instance_regions
Free · Read-only
Get a list of all regions for Azure Reserved Instance products available to the Microsoft CSP tenant.
crayon_prism_list_reserved_instance_skus
Free · Read-only
Get a list of all available Azure Reserved Instance SKUs available to the Microsoft CSP tenant.
crayon_prism_list_reserved_instance_terms
Free · Read-only
Get a list of all terms for Azure Reserved Instance products available to the Microsoft CSP tenant.
crayon_prism_list_tenant_azure_subscriptions
Free · Read-only
Get all active tenant's Azure Classic and Azure Plan subscriptions.
crayon_prism_set_azure_cost_management
Pro · Write
Switch Azure Cost Management on or off for a subscription (a feature switch).
crayon_prism_set_azure_spend_threshold
Pro · Write
Set the monthly usage notification threshold of an Azure subscription (an alert setting only).
crayon_prism_set_azure_subscription_partner_role
Pro · Destructive
Change the partner's access level on an Azure subscription.
crayon_prism_set_azure_usage_spike_alert
Pro · Write
Set the usage spike alert of an Azure subscription (an alert setting only).
crayon_prism_set_future_azure_spend_threshold
Pro · Write
Set the usage spend threshold applied to existing and future Azure subscriptions (an alert setting only).
crayon_prism_set_reserved_instance_partner_role
Pro · Destructive
Change the partner's access level on an Azure Reserved Instance.
crayon_prism_start_azure_plan_upgrade
Pro · Destructive
Start the upgrade of a tenant from Azure Classic to Azure Plan, which moves the tenant's Azure billing to Azure Plan (asynchronous: PRISM answers 202 with a longRunningTaskRef and the work finishes in the background, so crayon_prism_get_long_running_task reports the outcome).
crayon_prism_validate_azure_subscription_name
Free · Read-only
Validates whether a given Azure subscription name is valid for a given tenant.

PRISM Microsoft CSP subscriptions

ToolWhat it does
crayon_prism_bulk_migrate_tenant_subscriptions_to_nce
Pro · Destructive
Migrate many of a tenant's legacy Microsoft subscriptions to New Commerce Experience in one call; the term and price change.
crayon_prism_cancel_csp_subscription
Pro · Destructive
Cancel a Microsoft CSP subscription (asynchronous: PRISM answers 202 with a longRunningTaskRef and the work finishes in the background, so crayon_prism_get_long_running_task reports the outcome).
crayon_prism_cancel_isv_addon_subscription
Pro · Destructive
Cancel an ISV add-on subscription.
crayon_prism_cancel_subscription_migration_schedule
Pro · Destructive
Cancel a scheduled migration of a legacy Microsoft subscription to New Commerce Experience.
crayon_prism_check_csp_subscription_can_be_deleted
Free · Read-only
Check whether an Azure plan entitlement can be deleted, judged on its transfers data (the Swagger document declares no response shape).
crayon_prism_check_subscription_nce_migration
Free · Read-only
Checks if a legacy subscription is eligible for migrating to New Commerce Experience.
crayon_prism_confirm_csp_subscription_suspension
Pro · Destructive
Confirm the suspension of a Microsoft NCE subscription (asynchronous: PRISM answers 202 with a longRunningTaskRef and the work finishes in the background, so crayon_prism_get_long_running_task reports the outcome).
crayon_prism_create_isv_addon_subscription
Pro · Destructive
Add an ISV add-on subscription to a Microsoft CSP tenant; the add-on is billed.
crayon_prism_delete_csp_subscription_renewal
Pro · Destructive
Delete a scheduled renewal of a Microsoft CSP subscription.
crayon_prism_get_csp_subscription
Free · Read-only
Get the details of the specified subscription.
crayon_prism_get_csp_subscription_estimated_spend
Free · Read-only
Get the estimated monthly spend for a Microsoft CSP subscription.
crayon_prism_get_csp_subscription_with_addons
Free · Read-only
Gets subscription including nested add-ons converted into a flat list.
crayon_prism_get_isv_addon_subscription
Free · Read-only
Get the details of a Tenant ISV add on Subscription.
crayon_prism_get_subscription_migration_schedule
Free · Read-only
Get the scheduled migration of a legacy Microsoft subscription to New Commerce Experience, if there is one.
crayon_prism_list_csp_subscription_addons
Free · Read-only
Get the available addon products for a subscription.
crayon_prism_list_csp_tenant_subscriptions
Free · Read-only
Get active subscriptions for a tenant.
crayon_prism_list_csp_tenant_subscriptions_for_product
Free · Read-only
Get the subscriptions for a tenant that contain a specific product.
crayon_prism_list_subscription_coterminous_end_dates
Free · Read-only
Get coterminosity end dates of the specified subscription.
crayon_prism_list_subscription_custom_term_end_dates
Free · Read-only
Get custom term end dates of the specified subscription.
crayon_prism_list_subscription_renewal_products
Free · Read-only
Gets the products available for subscription renewal.
crayon_prism_list_subscription_transition_options
Free · Read-only
Get the transition/upgrade eligibilities for a subscription.
crayon_prism_list_tenant_migration_candidates
Free · Read-only
Gets the Subscriptions Ids of tenant to migrate.
crayon_prism_list_tenant_migration_candidates_with_addons
Free · Read-only
Gets the Subscriptions with all nested add-ons of tenant to migrate.
crayon_prism_migrate_subscription_to_nce
Pro · Destructive
Migrate an eligible legacy Microsoft subscription to New Commerce Experience; the term and price change.
crayon_prism_rename_csp_subscription
Pro · Write
Change the friendly name of a Microsoft CSP subscription (a label only) (asynchronous: PRISM answers 202 with a longRunningTaskRef and the work finishes in the background, so crayon_prism_get_long_running_task reports the outcome).
crayon_prism_renew_csp_subscription
Pro · Destructive
Renew a Microsoft CSP subscription with a quantity change, which commits a new term and bills it.
crayon_prism_resume_csp_subscription
Pro · Destructive
Resume a suspended Microsoft CSP subscription; its billing resumes (asynchronous: PRISM answers 202 with a longRunningTaskRef and the work finishes in the background, so crayon_prism_get_long_running_task reports the outcome).
crayon_prism_schedule_subscription_migration
Pro · Destructive
Schedule the migration of a legacy Microsoft subscription to New Commerce Experience.
crayon_prism_set_csp_subscription_quantity
Pro · Destructive
Change the quantity of a Microsoft CSP subscription, which changes what is billed (asynchronous: PRISM answers 202 with a longRunningTaskRef and the work finishes in the background, so crayon_prism_get_long_running_task reports the outcome).
crayon_prism_set_isv_addon_quantity
Pro · Destructive
Change the quantity of an ISV add-on subscription, which changes what is billed.
crayon_prism_suspend_csp_subscription
Pro · Destructive
Suspend a Microsoft CSP subscription (asynchronous: PRISM answers 202 with a longRunningTaskRef and the work finishes in the background, so crayon_prism_get_long_running_task reports the outcome).
crayon_prism_transition_csp_subscription
Pro · Destructive
Transition (upgrade) a Microsoft CSP subscription to another product, which changes what is billed (asynchronous: PRISM answers 202 with a longRunningTaskRef and the work finishes in the background, so crayon_prism_get_long_running_task reports the outcome).
crayon_prism_update_csp_subscription_renewal
Pro · Destructive
Update the renewal options of a Microsoft CSP subscription, which changes what is billed next term (asynchronous: PRISM answers 202 with a longRunningTaskRef and the work finishes in the background, so crayon_prism_get_long_running_task reports the outcome).
crayon_prism_update_csp_subscription_scheduled_actions
Pro · Destructive
Replace the scheduled actions (renewal options) of a Microsoft CSP subscription; it is a PUT, so read the current ones first and send the whole set back (asynchronous: PRISM answers 202 with a longRunningTaskRef and the work finishes in the background, so crayon_prism_get_long_running_task reports the outcome).

PRISM Orders

ToolWhat it does
crayon_prism_create_csp_addon_order
Pro · Destructive
Place an order for a Microsoft CSP add-on subscription on an existing subscription; the add-on is billed to the partner (asynchronous: PRISM answers 202 with a longRunningTaskRef and the work finishes in the background, so crayon_prism_get_long_running_task reports the outcome).
crayon_prism_create_csp_order
Pro · Destructive
Place an order that creates new Microsoft CSP subscriptions on a tenant; every subscription ordered is billed to the partner, and an annual order can wait for upfront payment before it activates (asynchronous: PRISM answers 202 with a longRunningTaskRef and the work finishes in the background, so crayon_prism_get_long_running_task reports the outcome).
crayon_prism_get_long_running_task
Free · Read-only
Get the status and outcome of a long running task.

PRISM Agreements and programs

ToolWhat it does
crayon_prism_clear_contract_agreement_email
Pro · Destructive
Remove the notification email address from a contract agreement.
crayon_prism_confirm_agreement_partner_center_instance
Pro · Destructive
Confirm that the partner's Partner Center instance has been set up for a contract agreement.
crayon_prism_get_agreement_partner_center_instance
Free · Read-only
Getting the partner center instance for the contract agreement.
crayon_prism_get_contract_agreement
Free · Read-only
Get the details of a contract agreement.
crayon_prism_get_program_guide
Free · Read-only
Get the program guide for a given vendor program type.
crayon_prism_list_contract_agreement_customers
Free · Read-only
Get customers for a contract agreement.
crayon_prism_list_contract_agreement_tenants
Free · Read-only
Get a list of contract agreement tenants.
crayon_prism_list_contract_agreements
Free · Read-only
List the active contract agreements of the caller's company (also the call Test Connection uses to prove the PRISM credentials).
crayon_prism_list_contract_agreements_by_program
Free · Read-only
Get all the contracts for a given program.
crayon_prism_list_contract_agreements_by_vendor_program
Free · Read-only
Get all the contract agreements for a given vendor.
crayon_prism_list_csp_agreements_for_end_customer
Free · Read-only
Get a list of contract agreements.
crayon_prism_list_customer_contract_agreements
Free · Read-only
Get all the contract agreements available in PRISM Portal.
crayon_prism_list_program_countries
Free · Read-only
Get a list of valid countries for a program.
crayon_prism_list_program_customers
Free · Read-only
List of customers within a program.
crayon_prism_list_program_plan_agreements
Free · Read-only
Get all Program Agreements for a given customer.
crayon_prism_list_program_products
Free · Read-only
Returns a paged product summary collection of all products for this program.
crayon_prism_list_programs
Free · Read-only
Get a list of programs and customer signup status.
crayon_prism_list_reseller_contract_agreements
Free · Read-only
Get the reseller contract agreements for a customer.
crayon_prism_search_program_products
Free · Read-only
Returns a product summary collection of all products for this program.
crayon_prism_set_contract_agreement_email
Pro · Write
Set the notification email address on a contract agreement (it changes who PRISM mails about the agreement, not what is billed).
crayon_prism_set_contract_agreement_po_number
Pro · Write
Set the recurring purchase order number printed on a contract agreement's invoices (metadata only, reversible).

PRISM Invoices and billing

ToolWhat it does
crayon_prism_download_invoice_csv
Free · Read-only
Download an invoice as a CSV document.
crayon_prism_download_invoice_file
Free · Read-only
Download an invoice's metadata file by id (a file stream).
crayon_prism_download_invoice_pdf
Free · Read-only
Download an invoice as a PDF document.
crayon_prism_email_invoice_bundle
Pro · Write
Email a ZIP archive of the selected invoices to an email address.
crayon_prism_get_invoice
Free · Read-only
Fetch a particular invoice.
crayon_prism_get_year_to_date_spend
Free · Read-only
Get the current financial year's spend to date, grouped by currency code.
crayon_prism_list_customer_invoices_by_vendor_program
Free · Read-only
Get a list of customer invoices for a vendor program.
crayon_prism_list_invoice_billing_statement_items
Free · Read-only
Get the billing statment item data related to an Invoice.
crayon_prism_list_invoice_files
Free · Read-only
Get the metadata files related to an Invoice.
crayon_prism_list_invoice_items
Free · Read-only
Get a list of invoice items.
crayon_prism_list_invoices
Free · Read-only
List invoices for a customer (page with skip and take; PRISM's default take is 50).
crayon_prism_set_invoice_po_number
Pro · Write
Set the purchase order number on an invoice (metadata only, reversible) (asynchronous: PRISM answers 202 with a longRunningTaskRef and the work finishes in the background, so crayon_prism_get_long_running_task reports the outcome).

PRISM Pricing

ToolWhat it does
crayon_prism_calculate_customer_example_pricing
Free · Read-only
Calculating example pricing for customer using customer id.
crayon_prism_create_customer_price_rule
Pro · Destructive
Create a pricing rule that sets what an end customer is charged (crayon_prism_validate_customer_price_rule and crayon_prism_calculate_customer_example_pricing preview it first).
crayon_prism_export_agreement_price_list
Free · Read-only
Export the price list of a contract agreement as a file.
crayon_prism_export_program_price_list
Free · Read-only
Export the default price list of a program as a file.
crayon_prism_export_reserved_instance_price_list
Free · Read-only
Export the Azure Reserved Instance price list as a file.
crayon_prism_get_agreement_future_price_list_details
Free · Read-only
Retrieves the details of the following month's price list.
crayon_prism_get_agreement_price_list
Free · Read-only
Get a price list for the given agreement.
crayon_prism_get_agreement_price_list_at_date
Free · Read-only
Get a price list for the given agreement.
crayon_prism_get_current_program_price_list
Free · Read-only
Get a price list as at the current day.
crayon_prism_get_customer_price_rules
Free · Read-only
Getting partner customer pricing rules using customer id for validation.
crayon_prism_get_default_future_price_list_details
Free · Read-only
Retrieves a summary of the following month's price list.
crayon_prism_get_default_program_price_list
Free · Read-only
The current default program price list.
crayon_prism_get_program_price_list
Free · Read-only
Get a price list.
crayon_prism_get_prorated_price
Free · Read-only
Get a prorated price for a given item.
crayon_prism_get_quote
Free · Read-only
Get a quote.
crayon_prism_get_subscription_vendor_fx_rate
Free · Read-only
Get the estimated FX Rate for the current month.
crayon_prism_list_csp_product_promotions
Free · Read-only
Gets the Microsoft CSP Product Promotions with paginaton.
crayon_prism_validate_customer_price_rule
Free · Read-only
Using customer id to validate price rule for customer.

PRISM Usage reporting

ToolWhat it does
crayon_prism_add_usage_program_customer
Pro · Write
Add a customer to a usage program (v2, keyed by programId).
crayon_prism_create_usage_reporting_customer
Pro · Write
Create a customer for usage reporting under a vendor program (v1, keyed by vendorProgramType; crayon_prism_add_usage_program_customer is the v2 form keyed by programId).
crayon_prism_deactivate_usage_program_customer
Pro · Destructive
Deactivate a usage program customer so usage can no longer be collected for it.
crayon_prism_get_usage_for_period
Free · Read-only
Get the usage details for the specific period.
crayon_prism_get_usage_summary
Free · Read-only
Get the Usage summaries for the program.
crayon_prism_list_usage_program_customers
Free · Read-only
View existing customer associations with usage program contract agreements.
crayon_prism_reactivate_usage_program_customer
Pro · Destructive
Reactivate a usage program customer so usage can be collected again; billing for its usage resumes.
crayon_prism_reset_usage_report
Pro · Destructive
Reset the usage report submitted for a period so it can be edited and submitted again.
crayon_prism_save_usage_items
Pro · Destructive
Save usage line items against a program agreement and period without submitting them; once submitted they are billed.
crayon_prism_submit_usage_adjustment
Pro · Destructive
Submit a usage adjustment for a period that was already reported; the adjustment is billed.
crayon_prism_submit_usage_report
Pro · Destructive
Submit the usage report for a program agreement and period; PRISM turns the submitted usage into the partner's invoice for that period.
crayon_prism_submit_zero_usage
Pro · Destructive
Declare zero usage for a program agreement and period, which bills nothing for it and closes the period.