# Suger API Reference CRUD operations on a set of resources, including organizations, products, offers, entitlements, usage record groups for meterting, etc. **Base URL:** `https://api.suger.cloud`. Most endpoints are scoped to an organization under `/org/{orgId}/…`, and request and response bodies are JSON (`application/json`). ## Authentication The API uses the OAuth 2.0 client-credentials flow. Create an OAuth App to get a client ID and secret, exchange them for a short-lived (1 hour) bearer token, then send it on every request as `Authorization: Bearer `. See [API Access](https://doc.suger.io/get-started/oauth-app.md) for the full token exchange, caching, rotation, and permissions. Pagination, errors, request bodies, versioning, and idempotency are covered on the [API reference page](https://doc.suger.io/api/). ## Operations 170 public operations, each with its own markdown page. ### API - [List API Clients](https://doc.suger.io/api/list-api-clients.md) — `GET /org/{orgId}/apiClient` — List all API clients in the given organization. - [Get API Client](https://doc.suger.io/api/get-api-client.md) — `GET /org/{orgId}/apiClient/{apiClientId}` — Get the API client by ID. ### Auditing - [Query Auditing Events](https://doc.suger.io/api/query-auditing-events.md) — `GET /org/{orgId}/auditingEvent/query` — Query auditing events with filtering, sorting, and pagination using CRUD query language. ### Buyer - [List Buyers](https://doc.suger.io/api/list-buyers.md) — `GET /org/{orgId}/buyer` — list buyers by the given organization with pagination and optional filters. - [Create Buyer](https://doc.suger.io/api/create-buyer.md) — `POST /org/{orgId}/buyer` — create a new buyer for Stripe or Adyen under the given organization. - [Query Buyers](https://doc.suger.io/api/query-buyers.md) — `GET /org/{orgId}/buyer/query` — Query buyers with filtering, sorting, and pagination using CRUD query language. - [Get Buyer](https://doc.suger.io/api/get-buyer.md) — `GET /org/{orgId}/buyer/{buyerId}` — get buyer by the given organization and buyer id. - [Update Buyer](https://doc.suger.io/api/update-buyer.md) — `PATCH /org/{orgId}/buyer/{buyerId}` — update buyer by the given organization and buyer id. - [List Buyer's Wallets](https://doc.suger.io/api/list-buyer-wallets.md) — `GET /org/{orgId}/buyer/{buyerId}/wallet` — list all wallets of a buyer. - [Create Credit Wallet](https://doc.suger.io/api/create-credit-wallet.md) — `POST /org/{orgId}/buyer/{buyerId}/wallet` — create a new credit wallet for the buyer. - [Update Credit Wallet](https://doc.suger.io/api/update-credit-wallet.md) — `PATCH /org/{orgId}/buyer/{buyerId}/wallet/{walletId}` — update startTime or expireTime of the wallet. - [Delete Buyer Wallet](https://doc.suger.io/api/delete-buyer-wallet.md) — `DELETE /org/{orgId}/buyer/{buyerId}/wallet/{walletId}` — delete a wallet of the buyer, if it's a payment method, sync to payment provider too. - [Close Credit Wallet](https://doc.suger.io/api/close-credit-wallet.md) — `PATCH /org/{orgId}/buyer/{buyerId}/wallet/{walletId}/close` — Close the given credit wallet, if it's a payment method, sync to payment provider too. - [Set Buyer Default Wallet](https://doc.suger.io/api/set-buyer-default-wallet.md) — `PATCH /org/{orgId}/buyer/{buyerId}/wallet/{walletId}/default` — set a payment method wallet as buyer's default wallet. ### Contact - [List Contacts](https://doc.suger.io/api/list-contacts.md) — `GET /org/{orgId}/contact` — List all contacts under the given organization. - [Create Contact](https://doc.suger.io/api/create-contact.md) — `POST /org/{orgId}/contact` — Create a contact under the given organization. - [Batch Create Contacts](https://doc.suger.io/api/batch-create-contacts.md) — `POST /org/{orgId}/contact/batch` — Create multiple contacts under the given organization. - [Query Contacts](https://doc.suger.io/api/query-contacts.md) — `GET /org/{orgId}/contact/query` — Query contacts with filtering, sorting, and pagination using the CRUD query language. - [Get Contact](https://doc.suger.io/api/get-contact.md) — `GET /org/{orgId}/contact/{contactId}` — Get the Contact by the given contact ID. - [Update Contact](https://doc.suger.io/api/update-contact.md) — `PATCH /org/{orgId}/contact/{contactId}` — Update the contact for the given organization and contact ID. - [Add Contact to Buyer](https://doc.suger.io/api/add-contact-to-buyer.md) — `POST /org/{orgId}/contact/{contactId}/buyer/{buyerId}` — add contact to buyer by the given organization, buyer id and contact id. - [Remove Contact from Buyer](https://doc.suger.io/api/remove-contact-from-buyer.md) — `DELETE /org/{orgId}/contact/{contactId}/buyer/{buyerId}` — remove contact from buyer by the given organization, buyer id and contact id. - [Add Contact to Offer](https://doc.suger.io/api/add-contact-to-offer.md) — `POST /org/{orgId}/contact/{contactId}/offer/{offerId}` — add contact to offer by the given organization, offer id and contact id. - [Remove Contact from Offer](https://doc.suger.io/api/remove-contact-from-offer.md) — `DELETE /org/{orgId}/contact/{contactId}/offer/{offerId}` — remove contact from offer by given organization, offer id and contact id. - [Update Contact Tags](https://doc.suger.io/api/update-contact-tags.md) — `PATCH /org/{orgId}/contact/{contactId}/tag` — Update the tags for a contact. ### Cosell - [Get Co-Sell Dashboard / Insights](https://doc.suger.io/api/get-cosell-dashboard.md) — `GET /org/{orgId}/cosell/metric` — Retrieve co-sell analytics for the organization. - [Search AWS connected partners by name](https://doc.suger.io/api/search-partner-connections.md) — `POST /org/{orgId}/cosell/partner/AWS/searchPartner` — Search the org's connected AWS partners by name. - [Search Microsoft first-party products for an Azure co-sell](https://doc.suger.io/api/azure-microsoft-solution-lookup.md) — `GET /org/{orgId}/cosell/partner/AZURE/microsoftSolutions/lookup/{searchTerm}` — Search Microsoft's own products (Azure, Microsoft 365, Dynamics and the rest of the first-party catalog) by… - [Invite a partner to collaborate on an Azure referral (Azure only)](https://doc.suger.io/api/azure-invite-partner-collaboration.md) — `POST /org/{orgId}/cosell/partner/AZURE/referral/{referralId}/invitePartner` — Send a collaboration invitation to another Microsoft partner on an existing Azure co-sell referral. - [Search third-party solutions for an Azure co-sell](https://doc.suger.io/api/azure-third-party-solution-lookup.md) — `GET /org/{orgId}/cosell/partner/AZURE/thirdPartySolutions/lookup/{searchTerm}` — Search the solutions published by companies other than Microsoft in the Partner Center catalog, and return… - [List known partner contacts for a buyer company](https://doc.suger.io/api/get-partner-contacts.md) — `GET /org/{orgId}/cosell/partner_contact` — Look up partner-side contacts (AWS / AZURE / GCP partner reps) associated with a buyer company, identified by… - [List co-sell referrals (inbound + outbound)](https://doc.suger.io/api/list-cosell-referrals.md) — `GET /org/{orgId}/cosell/referral` — List co-sell referrals under the organization with pagination, filters, and sort. - [Create a Co-Sell Referral (Outbound)](https://doc.suger.io/api/create-cosell-referral.md) — `POST /org/{orgId}/cosell/referral` — Create a new outbound co-sell referral to share a sales opportunity with a cloud partner (AWS / AZURE / GCP). - [Batch Create Co-Sell Referrals](https://doc.suger.io/api/batch-create-cosell-referrals.md) — `POST /org/{orgId}/cosell/referral/batchCreate` — Create multiple co-sell referrals in one call. - [Preview co-sell referrals mapped from CRM records](https://doc.suger.io/api/batch-preview-cosell-referrals.md) — `POST /org/{orgId}/cosell/referral/batchPreview` — Read one or more CRM records (for example Salesforce Opportunities) and return what each would look like as a… - [Register a co-sell on a partner's behalf](https://doc.suger.io/api/register-cosell-on-behalf.md) — `POST /org/{orgId}/cosell/referral/onBehalf` — Files a Suger PRM co-sell (`partner=SUGER`) that the seller is entering on a partner's behalf, for partners… - [Predict AWS Opportunity Quality Score](https://doc.suger.io/api/predict-referral-quality-score.md) — `POST /org/{orgId}/cosell/referral/predict-quality-score` — Predict the AWS opportunity quality score (0-100) for a not-yet-submitted AWS co-sell opportunity draft. - [Dry-run validate a co-sell referral against partner schema](https://doc.suger.io/api/validate-referral.md) — `POST /org/{orgId}/cosell/referral/validate` — Validate a mapped marketplace opportunity against the partner-specific schema (AWS ACE / Azure Partner Center… - [Get a co-sell referral by ID](https://doc.suger.io/api/get-cosell-referral.md) — `GET /org/{orgId}/cosell/referral/{referralId}` — Fetch full details of a single co-sell referral, including partner-specific fields, current Suger unified… - [Update a co-sell referral (incl. status / stage transitions)](https://doc.suger.io/api/update-cosell-referral.md) — `PATCH /org/{orgId}/cosell/referral/{referralId}` — Update fields of an existing co-sell referral. - [Apply a Commission Lifecycle Action](https://doc.suger.io/api/update-commission-lifecycle.md) — `PATCH /org/{orgId}/cosell/referral/{referralId}/commission` — Advance a SUGER co-sell's commission to its next state once the deal is Won. - [Propose a Post-Won Commission-Terms Update](https://doc.suger.io/api/propose-commission-update.md) — `POST /org/{orgId}/cosell/referral/{referralId}/commission-update` — Seller-only. - [Update a Partner's Co-Sell Copy](https://doc.suger.io/api/update-cosell-partner.md) — `PATCH /org/{orgId}/cosell/referral/{referralId}/partner` — Seller-only targeted write to one partner's reseller copy: revenue-share terms (pre-Won only), deal-value… - [Sync a single co-sell referral with the partner / CRM](https://doc.suger.io/api/sync-single-referral.md) — `POST /org/{orgId}/cosell/referral/{referralId}/sync` — Trigger a one-way sync for a specific referral. ### Entitlement - [List Entitlements](https://doc.suger.io/api/list-entitlements.md) — `GET /org/{orgId}/entitlement` — List entitlements under the given organization with pagination and optional filters. - [Create Entitlement](https://doc.suger.io/api/create-entitlement.md) — `POST /org/{orgId}/entitlement` — Create a new entitlement for the given buyer & offer. - [Query Entitlements](https://doc.suger.io/api/query-entitlements.md) — `GET /org/{orgId}/entitlement/query` — Query entitlements with filtering, sorting, and pagination using CRUD query language. - [Get Entitlement](https://doc.suger.io/api/get-entitlement.md) — `GET /org/{orgId}/entitlement/{entitlementId}` — Get the entitlement by ID. - [Add Entitlement Credit](https://doc.suger.io/api/add-entitlement-credit.md) — `POST /org/{orgId}/entitlement/{entitlementId}/addCredit` — Add the credit amount to the given Entitlement. - [Apply Addon to Entitlement](https://doc.suger.io/api/apply-addon-to-entitlement.md) — `POST /org/{orgId}/entitlement/{entitlementId}/addon` — Apply one billing addon to the given Entitlement. - [Approve Entitlement](https://doc.suger.io/api/approve-entitlement.md) — `POST /org/{orgId}/entitlement/{entitlementId}/approve` — Approve the given Entitlement. - [List Entitlement Cancellation Requests](https://doc.suger.io/api/list-entitlement-cancellation-requests.md) — `GET /org/{orgId}/entitlement/{entitlementId}/cancel` — List entitlement cancellation requests with filtering, sorting, and pagination. - [Cancel Entitlement](https://doc.suger.io/api/cancel-entitlement.md) — `POST /org/{orgId}/entitlement/{entitlementId}/cancel` — Cancel the active subscription. - [Withdraw Entitlement Cancellation Request](https://doc.suger.io/api/withdraw-entitlement-cancellation-request.md) — `POST /org/{orgId}/entitlement/{entitlementId}/cancel/withdraw` — Withdraw an entitlement cancellation request. - [Divide Entitlement Commit](https://doc.suger.io/api/divide-entitlement-commit.md) — `POST /org/{orgId}/entitlement/{entitlementId}/divideCommit` — Divide the commit equally from the given entitlement into sub entitlement terms based on the given time… - [Update Entitlement Name](https://doc.suger.io/api/update-entitlement-name.md) — `PATCH /org/{orgId}/entitlement/{entitlementId}/entitlementName` — Update the name of the given Entitlement. - [List Entitlement Terms](https://doc.suger.io/api/list-entitlement-terms.md) — `GET /org/{orgId}/entitlement/{entitlementId}/entitlementTerm` — List all Entitlement Terms of the given Entitlement. - [Get Entitlement Term](https://doc.suger.io/api/get-entitlement-term.md) — `GET /org/{orgId}/entitlement/{entitlementId}/entitlementTerm/{entitlementTermId}` — Get the entitlement term by ID. - [Delete Entitlement Term](https://doc.suger.io/api/delete-entitlement-term.md) — `DELETE /org/{orgId}/entitlement/{entitlementId}/entitlementTerm/{entitlementTermId}` — Delete the entitlement term by the given entitlement ID and entitlement term ID. - [Update Entitlement Meta Info](https://doc.suger.io/api/update-entitlement-meta-info.md) — `PATCH /org/{orgId}/entitlement/{entitlementId}/metaInfo` — Update the meta info of the given entitlement. - [Get Entitlement Agreement PDF](https://doc.suger.io/api/get-entitlement-pdf.md) — `GET /org/{orgId}/entitlement/{entitlementId}/pdf` — Returns a presigned S3 URL for the agreement PDF of the given AWS entitlement. - [Update Entitlement Price Model](https://doc.suger.io/api/update-entitlement-price-model.md) — `PATCH /org/{orgId}/entitlement/{entitlementId}/priceModel` — Update the price model of the given entitlement, such as recurring commits, billable dimensions. - [Adjust the renewal uplift for an entitlement](https://doc.suger.io/api/adjust-entitlement-renewal-uplift.md) — `POST /org/{orgId}/entitlement/{entitlementId}/renewal/adjustUplift` — Reprice the pending renewal offer to a seller-chosen in-range uplift (AWS). - [Get the draft renewal offer for an entitlement](https://doc.suger.io/api/get-entitlement-renewal-draft-offer.md) — `GET /org/{orgId}/entitlement/{entitlementId}/renewal/draftOffer` — Return the pending draft renewal offer as a WorkloadOffer so the seller can resume editing it (AWS). 404 when… - [Opt out of auto-renewal for an entitlement](https://doc.suger.io/api/opt-out-entitlement-renewal.md) — `POST /org/{orgId}/entitlement/{entitlementId}/renewal/optOut` — Expire the pending renewal offer so the agreement does not auto-renew (AWS). - [Schedule Entitlement Cancellation](https://doc.suger.io/api/schedule-entitlement-cancellation.md) — `POST /org/{orgId}/entitlement/{entitlementId}/scheduleCancellation` — Schedule the cancellation of the given Entitlement. - [Update seat for the active AZURE subscription](https://doc.suger.io/api/update-entitlement-seat.md) — `PATCH /org/{orgId}/entitlement/{entitlementId}/seat` — Update the seat number for the active AZURE subscription. - [Unschedule Entitlement Cancellation](https://doc.suger.io/api/unschedule-entitlement-cancellation.md) — `POST /org/{orgId}/entitlement/{entitlementId}/unscheduleCancellation` — Unschedule the cancellation of the given Entitlement. ### Knowledge Search - [Search Marketplace Knowledge](https://doc.suger.io/api/search-knowledge.md) — `POST /org/{orgId}/knowledge/search` — Searches the shared knowledge index covering AWS, Azure, and GCP marketplace documentation, Suger docs, and… ### Metering - [Batch Report usageRecordGroups](https://doc.suger.io/api/batch-report-usage-record-groups.md) — `POST /org/{orgId}/batchCreateUsageRecordGroups` — Batch report new usage record groups. - [Batch Validate usageRecordGroups](https://doc.suger.io/api/batch-validate-usage-record-groups.md) — `POST /org/{orgId}/batchValidateUsageRecordGroups` — Provide a batch of usage record groups and validate each individual usage record group one by one. - [List Billable Metrics](https://doc.suger.io/api/list-billable-metrics.md) — `GET /org/{orgId}/billableMetric` — list billable metrics for the given organization. - [Create Billable Metric](https://doc.suger.io/api/create-billable-metric.md) — `POST /org/{orgId}/billableMetric` — Create a new billable metric for the given organization. - [Get Billable Metric](https://doc.suger.io/api/get-billable-metric.md) — `GET /org/{orgId}/billableMetric/{billableMetricId}` — Get the billable metric for the given organization and billable metric ID. - [Update Billable Metric](https://doc.suger.io/api/update-billable-metric.md) — `PATCH /org/{orgId}/billableMetric/{billableMetricId}` — Update the name, description and status of the billable metric for the given organization. - [Report usageRecordGroup](https://doc.suger.io/api/report-usage-record-group.md) — `POST /org/{orgId}/entitlement/{entitlementId}/usageRecordGroup` — Provide the ID in the request body CreateUsageRecordGroupParams so the report can be deduplicated. - [Get Usage Metering Config Info](https://doc.suger.io/api/get-usage-metering-config-info.md) — `GET /org/{orgId}/usageMeteringConfigInfo` — Get the usage metering config info of the given organization. - [Update Usage Metering Config Info](https://doc.suger.io/api/update-usage-metering-config-info.md) — `PATCH /org/{orgId}/usageMeteringConfigInfo` — Update the usage metering config info of the given organization. - [List usageRecordGroups](https://doc.suger.io/api/list-usage-record-groups.md) — `GET /org/{orgId}/usageRecordGroup` — List UsageRecordGroups by the given organization, partner, product, entitlement or buyer. - [Aggregate usageRecordGroups](https://doc.suger.io/api/aggregate-usage-record-groups.md) — `GET /org/{orgId}/usageRecordGroup/aggregate` — Aggregate usageRecordGroups by date and dimension key. - [Delete usageRecordGroup](https://doc.suger.io/api/delete-usage-record-group.md) — `DELETE /org/{orgId}/usageRecordGroup/{usageRecordGroupId}` — delete the UsageRecordGroup for the given organization and usageRecordGroup ID. - [Retry usageRecordGroup](https://doc.suger.io/api/retry-usage-record-group.md) — `POST /org/{orgId}/usageRecordGroup/{usageRecordGroupId}/retry` — Retry the given UsageRecordGroup by setting from status "REPORT_FAILED" to "CREATED", and it will be ready… - [List usageRecordReports](https://doc.suger.io/api/list-usage-record-reports.md) — `GET /org/{orgId}/usageRecordReport` — List usageRecordReports under the given organization, partner, entitlement or buyer, within the given time… - [Aggregate usageRecordReports](https://doc.suger.io/api/aggregate-usage-record-reports.md) — `GET /org/{orgId}/usageRecordReport/aggregate` — Aggregate usageRecordReports by date and dimension key. ### Notification - [Get Notification Config Info](https://doc.suger.io/api/get-notification-config-info.md) — `GET /org/{orgId}/notificationConfigInfo` — Get the notification config info of the given organization. - [Update Notification Config Info](https://doc.suger.io/api/update-notification-config-info.md) — `PATCH /org/{orgId}/notificationConfigInfo` — Update the notification config info of the given organization. - [List Notification Events](https://doc.suger.io/api/list-notification-events.md) — `GET /org/{orgId}/notificationEvent` — List the notification events of the given organization with pagination and optional filters. - [List Notification Events by Entity](https://doc.suger.io/api/list-notification-events-by-entity.md) — `GET /org/{orgId}/notificationEvent/{entityType}/{entityId}` — List the notification events of the given organization and entity with pagination. - [List Notification Messages](https://doc.suger.io/api/list-notification-messages.md) — `GET /org/{orgId}/notificationMessage` — List or search the notification messages of the given organization with pagination. - [Get Notification Message](https://doc.suger.io/api/get-notification-message.md) — `GET /org/{orgId}/notificationMessage/{notificationMessageId}` — Get the notification message of the organization & notification message ID. ### Offer - [Create or Update Draft Offer](https://doc.suger.io/api/create-or-update-draft-offer.md) — `POST /org/{orgId}/draftOffer` — Create a new draft offer or update the existing draft offer. - [List Offers](https://doc.suger.io/api/list-offers.md) — `GET /org/{orgId}/offer` — List offers under the given organization with pagination and optional filter. - [Create Offer](https://doc.suger.io/api/create-offer.md) — `POST /org/{orgId}/offer` — Create a private offer under the given organization. - [Query Offers](https://doc.suger.io/api/query-offers.md) — `GET /org/{orgId}/offer/query` — Query offers with filtering, sorting, and pagination using CRUD query language. - [Get Offer](https://doc.suger.io/api/get-offer.md) — `GET /org/{orgId}/offer/{offerId}` — Get the offer by the given offer ID. - [Delete Offer](https://doc.suger.io/api/delete-offer.md) — `DELETE /org/{orgId}/offer/{offerId}` — The offer is soft deleted (marked as DELETED status) in Suger service. - [Cancel Offer](https://doc.suger.io/api/cancel-offer.md) — `POST /org/{orgId}/offer/{offerId}/cancel` — Only the offer with status = "PENDING_ACCEPTANCE", "PENDING_CANCEL", "ACTIVE" or "USED" is allowed to cancel. - [Get Offer EULA](https://doc.suger.io/api/get-offer-eula.md) — `GET /org/{orgId}/offer/{offerId}/eula` — Get the EULA file of the given offer ID. - [Extend Offer Expiry Date](https://doc.suger.io/api/extend-private-offer-expiry-date.md) — `POST /org/{orgId}/offer/{offerId}/extendExpiryDate` — Only the offer with status = "PENDING_ACCEPTANCE", "EXPIRED", "ACCEPTED" or "UPDATE_FAILED" is allowed to… - [Update Offer Meta Info](https://doc.suger.io/api/update-offer-meta-info.md) — `PATCH /org/{orgId}/offer/{offerId}/metaInfo` — Update the meta info of the given offer. - [Notify Offer Contacts](https://doc.suger.io/api/send-offer-notifications.md) — `POST /org/{orgId}/offer/{offerId}/notifyContacts` — Send offer notifications to the given contact ids. - [Update Offer Pricing (Unified Format)](https://doc.suger.io/api/update-offer-price.md) — `PATCH /org/{orgId}/offer/{offerId}/price` — Add new usage dimensions or update existing dimension rates (at negotiated rates) on a released AWS private… - [Get Offer Reseller EULA](https://doc.suger.io/api/get-offer-reseller-eula.md) — `GET /org/{orgId}/offer/{offerId}/resellerEula` — Get the Reseller EULA file of the given offer ID. - [Sync Offer](https://doc.suger.io/api/sync-offer.md) — `POST /org/{orgId}/offer/{offerId}/sync` — Sync the given offer from its partner. - [Get Offer by External ID](https://doc.suger.io/api/get-offer-by-external-id.md) — `GET /org/{orgId}/offerExternalId/{offerExternalId}` — Get the offer by the given offer external ID. ### OfferSet - [List Offer Sets](https://doc.suger.io/api/list-offer-sets.md) — `GET /org/{orgId}/offerSet` — List offer sets under the given organization with filtering, sorting, and pagination using CRUD query… - [Create Offer Set](https://doc.suger.io/api/create-offer-set.md) — `POST /org/{orgId}/offerSet` — Create a new offer set under the given organization. - [Get Offer Set](https://doc.suger.io/api/get-offer-set.md) — `GET /org/{orgId}/offerSet/{offerSetId}` — Get the offer set by the given offer set ID. ### Operation - [List Operations with Filters](https://doc.suger.io/api/list-operations-v2.md) — `POST /org/{orgId}/v2/operation/list` — List or search workflow operations with filter expressions. - [Get Operation Details](https://doc.suger.io/api/get-operation-v2.md) — `GET /org/{orgId}/v2/operation/{operationId}` — Get the details of a Temporal workflow operation by operation ID. - [Get Operation History Events](https://doc.suger.io/api/list-operation-history-v2.md) — `GET /org/{orgId}/v2/operation/{operationId}/history` — Get the history events for a Temporal workflow operation by operation ID. ### Organization - [List organizations the current user or API client belongs to](https://doc.suger.io/api/list-organizations.md) — `GET /org` — List all organizations (also known as accounts or tenants) that the authenticated caller has access to. - [Update the organization's onboarding intent (skip/dismiss).](https://doc.suger.io/api/update-onboarding-info.md) — `PATCH /org/{orgId}/onboarding/info` — Updates the Get Started checklist intent for the organization. - [Get the organization's Get Started onboarding status.](https://doc.suger.io/api/get-onboarding-status.md) — `GET /org/{orgId}/onboarding/status` — Returns the six-step Get Started checklist state (account, marketplace, crm, notification, readiness… - [Get the current organization's services and quotas](https://doc.suger.io/api/get-organization-licenses-and-services.md) — `GET /org/{orgId}/services-and-quotas` — Customer-facing read endpoint returning the requesting organization's services snapshot — every catalog… ### Partner Relationship Management - [List all partner invitations in the organization](https://doc.suger.io/api/list-prm-org-invitations.md) — `GET /org/{orgId}/prm/invitation` — List every partner invitation this organization sent or received, with recipient, direction (outbound if this… - [Create PRM invitation for a new partner](https://doc.suger.io/api/create-prm-new-partner-invitation.md) — `POST /org/{orgId}/prm/invitation` — Creates and sends a partner invitation when the sender is inviting a company that is not yet a formal… - [Accept a partnership invitation received by this organization](https://doc.suger.io/api/accept-prm-in-app-invitation.md) — `POST /org/{orgId}/prm/invitation/{invitationId}/accept` — Accept an invitation that another company sent to this organization, establishing the partnership. - [Withdraw an invitation this organization sent](https://doc.suger.io/api/cancel-prm-invitation.md) — `POST /org/{orgId}/prm/invitation/{invitationId}/cancel` — Withdraw a partner invitation this organization sent, setting it to "Cancelled" and invalidating the accept… - [Decline a partnership invitation received by this organization](https://doc.suger.io/api/decline-prm-in-app-invitation.md) — `POST /org/{orgId}/prm/invitation/{invitationId}/decline` — Decline an invitation another company sent to this organization. - [Resend a pending or expired partner invitation](https://doc.suger.io/api/resend-prm-invitation.md) — `POST /org/{orgId}/prm/invitation/{invitationId}/resend` — Re-send an invitation this organization sent, refreshing its accept-by date and re-delivering the original… - [List Partner Relationships](https://doc.suger.io/api/list-prm-partners.md) — `GET /org/{orgId}/prm/partner` — List the partner companies this organization has a relationship with, one row per partnership, with… - [Draft a Partnership Invitation Email](https://doc.suger.io/api/generate-prm-invitation-email.md) — `POST /org/{orgId}/prm/partner/invitation/generate-email` — Generate a subject line and body for a partnership invitation email, written for a specific recipient using… - [List Invitation-Linkable Files](https://doc.suger.io/api/list-prm-invitation-linkable-files.md) — `GET /org/{orgId}/prm/partner/invitation/linkable-file` — List partner files that may be linked from a partner invitation email — only files shared with All Partners… - [Get One Partner Relationship](https://doc.suger.io/api/get-prm-partner-detail.md) — `GET /org/{orgId}/prm/partner/{partnerId}` — Retrieve the full record for one partner relationship: company profile, relationship and engagement type… - [Update One Partner Relationship](https://doc.suger.io/api/update-prm-partner.md) — `PATCH /org/{orgId}/prm/partner/{partnerId}` — Update the editable fields of one partner relationship: the assigned partner manager, the relationship… - [Get One Partner's Commission Ledger](https://doc.suger.io/api/get-partner-commissions.md) — `GET /org/{orgId}/prm/partner/{partnerId}/commissions` — Return the commission ledger for one partner from this organization's perspective: a record per closed-won… - [List the contacts at one partner company](https://doc.suger.io/api/get-prm-partner-contacts.md) — `GET /org/{orgId}/prm/partner/{partnerId}/contacts` — List the enrichment-sourced people at one partner company: name, email, job title, LinkedIn URL, seniority… - [List the invitations for one partner](https://doc.suger.io/api/list-prm-invitations.md) — `GET /org/{orgId}/prm/partner/{partnerId}/invitation` — List the invitations attached to a single partner relationship, each with its recipient, direction, status… - [Invite a contact to an existing partnership](https://doc.suger.io/api/create-prm-invitation.md) — `POST /org/{orgId}/prm/partner/{partnerId}/invitation` — Send a partner invitation for a partnership that already exists in this organization, addressed to a named… ### Product - [Create or Update Draft Product](https://doc.suger.io/api/create-or-update-draft-product.md) — `POST /org/{orgId}/draftProduct` — Create a new draft product or update the existing draft product. - [List Products by Partner](https://doc.suger.io/api/list-products-by-partner.md) — `GET /org/{orgId}/partner/{partner}/product` — list all products under the given organization and cloud partner - [List Products](https://doc.suger.io/api/list-products.md) — `GET /org/{orgId}/product` — list all products under the given organization - [Create Product](https://doc.suger.io/api/create-product.md) — `POST /org/{orgId}/product` — create a new product in the marketplace - [Query Products](https://doc.suger.io/api/query-products.md) — `GET /org/{orgId}/product/query` — Query products with filtering, sorting, and pagination using CRUD query language. - [Get Product](https://doc.suger.io/api/get-product.md) — `GET /org/{orgId}/product/{productId}` — get product by product id - [Update Product](https://doc.suger.io/api/update-product.md) — `PATCH /org/{orgId}/product/{productId}` — update product info, no price update is allowed via this API. - [Delete Product](https://doc.suger.io/api/delete-product.md) — `DELETE /org/{orgId}/product/{productId}` — The product is soft deleted (marked as DELETED status) in Suger service. only the products with non PUBLIC… - [List Metering Dimensions of Product](https://doc.suger.io/api/list-product-metering-dimensions.md) — `GET /org/{orgId}/product/{productId}/dimension` — list all metering dimensions of the given product - [Update Product Fulfillment URL](https://doc.suger.io/api/update-product-fulfillment-url.md) — `PATCH /org/{orgId}/product/{productId}/fulfillmentUrl` — update the fulfillment url of the given product - [Update Product Meta Info](https://doc.suger.io/api/update-product-meta-info.md) — `PATCH /org/{orgId}/product/{productId}/metaInfo` — Update the meta info of the given product. - [Update Product Pricing (Unified Format)](https://doc.suger.io/api/update-product-price.md) — `PATCH /org/{orgId}/product/{productId}/price` — Update AWS or Azure product pricing with one partner-agnostic request (plans[] with commits + dimensions). - [Update Product Pricing](https://doc.suger.io/api/update-product-pricing.md) — `PATCH /org/{orgId}/product/{productId}/pricing` — update product pricing/terms info. - [Publish Product](https://doc.suger.io/api/publish-product.md) — `PATCH /org/{orgId}/product/{productId}/publish` — publish the given product to the public status in the marketplace - [Update Product Allowlist](https://doc.suger.io/api/update-product-targeting.md) — `PATCH /org/{orgId}/product/{productId}/targeting` — Replace the buyer AWS accounts allowlisted to view and subscribe to a Limited-visibility AWS SaaS listing… ### Report - [List Daily Revenue Records](https://doc.suger.io/api/list-daily-revenue-records.md) — `GET /org/{orgId}/dailyRevenueRecord` — list daily revenue records for the given organization, partner, entitlement, or buyer, within the given date… - [List Revenue Records](https://doc.suger.io/api/list-revenue-records.md) — `GET /org/{orgId}/partner/{partner}/revenueRecord` — list the revenue records for the given organization, product, entitlement, or buyer. - [List Revenue Record Details](https://doc.suger.io/api/list-revenue-record-details.md) — `GET /org/{orgId}/partner/{partner}/revenueRecordDetail` — list the raw revenue record details for the given organization, partner, product, entitlement, or buyer. - [List Usage Metering Daily Records](https://doc.suger.io/api/list-usage-metering-daily-records.md) — `GET /org/{orgId}/partner/{partner}/usageMeteringDailyRecord` — list the daily records of the usage metering from the cloud marketplace for the given organization… - [Aggregate Revenue Records](https://doc.suger.io/api/aggregate-revenue-records.md) — `POST /org/{orgId}/revenueRecord/aggregate` — Return per-currency totals (invoice/collectable/disburse/tax + count) and the daily chart series over the… - [Query Revenue Records](https://doc.suger.io/api/query-revenue-records.md) — `GET /org/{orgId}/revenueRecord/query` — Query revenue records with filtering, sorting, and pagination using the CRUD query language. - [Get Revenue Report](https://doc.suger.io/api/get-revenue-report.md) — `POST /org/{orgId}/revenueReport` — Get the revenue report of the given organization, product, entitlement, or buyer. ### Revenue - [Trigger Revenue Backfill](https://doc.suger.io/api/backfill-revenue-connection.md) — `POST /org/{orgId}/revenue/connection/{partner}/backfill` — Start a historical revenue-data backfill for one marketplace connection, covering the trailing 24 months. - [Get Channel Connection Health](https://doc.suger.io/api/get-revenue-connection-health.md) — `GET /org/{orgId}/revenue/connection/{partner}/health` — Report sync health for one connected revenue channel: last sync time, last sync status, consecutive error… - [List Revenue Channel Connections](https://doc.suger.io/api/list-revenue-connections.md) — `GET /org/{orgId}/revenue/connections` — List the marketplace and payment channels in this organization that are connected for revenue sync. - [Get Revenue SAAS Metrics](https://doc.suger.io/api/get-revenue-dashboard-metrics.md) — `GET /org/{orgId}/revenue/dashboard/metrics` — Return SaaS revenue metrics for the organization over a date range, including ARR, MRR, and the ARR waterfall. - [Get Revenue Dashboard Summary](https://doc.suger.io/api/get-revenue-dashboard-summary.md) — `GET /org/{orgId}/revenue/dashboard/summary` — Aggregate unified revenue records across every connected channel into dashboard totals: billed, collected… - [Get Revenue Record Detail](https://doc.suger.io/api/get-unified-revenue-record.md) — `GET /org/{orgId}/revenue/record/{partner}/{recordId}` — Return one unified revenue record in full, including its billing, cash-collection, and disbursement amounts… - [Get the provenance event chain for a URR](https://doc.suger.io/api/get-revenue-record-events.md) — `GET /org/{orgId}/revenue/record/{partner}/{recordId}/events` — - [List Unified Revenue Records](https://doc.suger.io/api/list-unified-revenue-records.md) — `GET /org/{orgId}/revenue/records` — - [Summarize Unified Revenue Records](https://doc.suger.io/api/summarize-unified-revenue-records.md) — `GET /org/{orgId}/revenue/records/summary` — ### Support - [List Support Tickets](https://doc.suger.io/api/list-support-tickets.md) — `GET /org/{orgId}/support/ticket` — list support tickets - [Create Support Ticket](https://doc.suger.io/api/create-support-ticket.md) — `POST /org/{orgId}/support/ticket` — create support ticket - [Get Support Ticket](https://doc.suger.io/api/get-support-ticket.md) — `GET /org/{orgId}/support/ticket/{ticketId}` — get support ticket - [Update Support Ticket](https://doc.suger.io/api/update-support-ticket.md) — `PATCH /org/{orgId}/support/ticket/{ticketId}` — update support ticket - [Create Support Ticket Attachment](https://doc.suger.io/api/create-support-ticket-attachment.md) — `POST /org/{orgId}/support/ticket/{ticketId}/attachment` — create support ticket attachment - [Download Support Ticket Attachment](https://doc.suger.io/api/download-support-ticket-attachment.md) — `GET /org/{orgId}/support/ticket/{ticketId}/attachment/{attachmentId}` — Authenticated download of a support-ticket attachment (GitHub-Issues backend). - [Close Support Ticket](https://doc.suger.io/api/close-support-ticket.md) — `PATCH /org/{orgId}/support/ticket/{ticketId}/close` — close support ticket - [Create Support Ticket Comment](https://doc.suger.io/api/create-support-ticket-comment.md) — `POST /org/{orgId}/support/ticket/{ticketId}/comment` — create support ticket comment - [Reopen Support Ticket](https://doc.suger.io/api/reopen-support-ticket.md) — `PATCH /org/{orgId}/support/ticket/{ticketId}/reopen` — reopen support ticket