Zuora APIs used by Stigg

Documentation Index

Fetch the complete documentation index at: https://docs.stigg.io/llms.txt

Use this file to discover all available pages before exploring further.

Stigg interacts with Zuora through two API clients: the Quickstart API (v2) and the V1 API. The sections below list every endpoint Stigg calls and why.

​

Subscription Lifecycle Management

Stigg uses the V1 Orders API to create, update, and cancel subscriptions. Order actions allow multiple changes to be applied atomically in a single request.

​

Create Subscription

Creates a new Zuora subscription for a customer by submitting a CreateSubscription order action with charge overrides for per-unit, flat-fee, and add-on pricing.

• Endpoint: POST /v1/orders
• Order action: CreateSubscription
• Documentation: https://developer.zuora.com/v1-api-reference/api/operation/POST_Order/

​

Update Subscription

Modifies an existing subscription’s plan, seat quantities, or add-ons by applying UpdateProduct, AddProduct, and RemoveProduct order actions in a single atomic request.

• Endpoint: POST /v1/orders
• Order actions: UpdateProduct, AddProduct, RemoveProduct
• Documentation: https://developer.zuora.com/v1-api-reference/api/operation/POST_Order/

​

Cancel Subscription

Terminates an active subscription immediately using a CancelSubscription order action, optionally writing off any open invoice balance at cancellation time.

• Endpoint: POST /v1/orders
• Order action: CancelSubscription
• Documentation: https://developer.zuora.com/v1-api-reference/api/operation/POST_Order/

​

Scheduled Orders

Stigg creates orders with status: SCHEDULED and schedulingOptions to support future-dated subscription changes (downgrades, cancellations, and seat updates).

• Endpoint: POST /v1/orders
• Documentation: https://developer.zuora.com/v1-api-reference/api/operation/POST_Order/

​

Get Orders by Subscription

Used to retrieve existing scheduled orders for a subscription before creating or replacing them.

• Endpoint: GET /v1/orders?subscriptionNumber={subscriptionNumber}
• Documentation: https://developer.zuora.com/v1-api-reference/api/operation/GET_OrdersBySubscriptionNumber/

​

Cancel Order

Used to cancel a pending scheduled order.

• Endpoint: PUT /v1/orders/{orderNumber}/cancel
• Documentation: https://developer.zuora.com/v1-api-reference/api/operation/PUT_CancelOrder/

​

Preview Order

Used to generate an invoice preview before committing a subscription change.

• Endpoint: POST /v1/orders/preview
• Documentation: https://developer.zuora.com/v1-api-reference/api/operation/POST_PreviewOrder/

​

Preview Next Invoice

Used to preview the next upcoming invoice for an existing subscription.

• Endpoint: POST /v1/subscriptions/{subscriptionKey}/preview
• Documentation: https://developer.zuora.com/v1-api-reference/api/operation/POST_PreviewSubscription/

​

Customer Account Management

Stigg maps each Stigg customer to a Zuora account.

​

Create Account

Creates a new Zuora billing account for a Stigg customer, setting the billing contact, currency, default payment method, and Stigg-specific custom fields.

• Endpoint: POST /v2/accounts
• Documentation: https://developer.zuora.com/quickstart-api/operation/createAccount/

​

Get Account (Quickstart API)

Retrieves a Zuora account by ID to read current account state when syncing or updating a customer record.

• Endpoint: GET /v2/accounts/{accountId}
• Documentation: https://developer.zuora.com/quickstart-api/operation/getAccount/

​

Update Account (Quickstart API)

Updates a Zuora account with the latest name, billing contact, custom field metadata, and payment terms sourced from Stigg.

• Endpoint: PATCH /v2/accounts/{accountId}
• Documentation: https://developer.zuora.com/quickstart-api/operation/patchAccount/

​

Get Account (V1 API)

Used when the Quickstart account object is insufficient (e.g., to obtain accountNumber for order creation).

• Endpoint: GET /v1/accounts/{accountKey}
• Documentation: https://developer.zuora.com/v1-api-reference/api/operation/GET_Account/

​

Product Catalog Sync

Stigg syncs its plan and add-on catalog to Zuora products, plans (rate plans), and prices (charges).

​

Create / Get / Update Product

Syncs Stigg plan and add-on packages to Zuora products, creating a new product on first sync and patching it when the name, description, or custom fields change.

• Endpoints:
  • POST /v2/products
  • GET /v2/products/{productId}
  • PATCH /v2/products/{productId}
• Documentation: https://developer.zuora.com/quickstart-api/operation/createProduct/

​

Create / Get Plan

Creates a Zuora rate plan (plan) under a product for each billing period, grouping all associated charges for a given Stigg plan or add-on.

• Endpoints:
  • POST /v2/plans
  • GET /v2/plans/{planId}
• Documentation: https://developer.zuora.com/quickstart-api/operation/createPlan/

​

Create Price (V1 API)

Stigg uses the V1 Product Rate Plan Charges API to create charges because it supports the full set of charge configuration options required (tiered pricing, volume pricing, min/max quantities, accounting codes).

• Endpoint: POST /v1/object/product-rate-plan-charge
• Documentation: https://developer.zuora.com/v1-api-reference/api/operation/Object_POSTProductRatePlanCharge/

​

Get Price (V1 API)

Used to detect drift between Stigg’s price configuration and what is stored in Zuora.

• Endpoint: GET /v1/product-rate-plan-charges/{productRatePlanChargeKey}
• Documentation: https://developer.zuora.com/v1-api-reference/api/operation/GET_ProductRatePlanCharge/

​

Get / Update Price (Quickstart API)

Reads or patches a Zuora price via the Quickstart API for lightweight price lookups and updates that don’t require the full V1 charge configuration options.

• Endpoints:
  • GET /v2/prices/{priceId}
  • PATCH /v2/prices/{priceId}
• Documentation: https://developer.zuora.com/quickstart-api/operation/getPrice/

​

Create Unit of Measure

Stigg creates a unit of measure in Zuora for every usage-based feature, used when creating per-unit and usage-based charges.

• Endpoint: POST /v1/object/unit-of-measure
• Documentation: https://developer.zuora.com/v1-api-reference/api/operation/Object_POSTUnitOfMeasure/

​

Subscription Data Access

​

Get Subscription (Quickstart API)

Used when syncing usage data to resolve the correct subscription item and unit of measure.

• Endpoint: GET /v2/subscriptions/{subscriptionId}
• Documentation: https://developer.zuora.com/quickstart-api/operation/getSubscriptionByKey/

​

Get Subscription (V1 API)

Used to read rate plan and charge details that are only available through the V1 API.

• Endpoint: GET /v1/subscriptions/{subscriptionKey}
• Documentation: https://developer.zuora.com/v1-api-reference/api/operation/GET_SubscriptionsByKey/

​

Payment Method Management

Stigg manages payment methods to support Zuora-hosted payment forms and payment method attachment.

​

Get Payment Method

Retrieves a payment method by ID to check its current account_id, used when determining whether the method needs to be transferred to a different Zuora account before being set as default.

• Endpoint: GET /v2/payment-methods/{paymentMethodId}
• Documentation: https://developer.zuora.com/quickstart-api/operation/getPaymentMethodById/

​

Create Payment Method

Used to create a CC_REF payment method when attaching a payment method tokenized via Stripe.

• Endpoint: POST /v2/payment-methods
• Documentation: https://developer.zuora.com/quickstart-api/operation/createPaymentMethod/

​

Update Payment Method

Used to transfer a payment method to the correct account when a new default payment method is set.

• Endpoint: PATCH /v2/payment-methods/{paymentMethodId}
• Documentation: https://developer.zuora.com/quickstart-api/operation/updatePaymentMethod/

​

Usage Reporting

Stigg reports metered feature usage to Zuora as usage records.

​

Create Usage Record

Submits a new metered usage record to Zuora for a subscription item when no pending record already exists for the current billing period.

• Endpoint: POST /v2/usage-records
• Documentation: https://developer.zuora.com/quickstart-api/operation/createUsage/

​

Update Usage Record

Stigg upserts usage records within a billing period — if a pending record already exists for the current period, it is updated instead of creating a duplicate.

• Endpoint: PATCH /v2/usage-records/{id}
• Documentation: https://developer.zuora.com/quickstart-api/operation/updateUsage/

​

List Usage Records

Used to check for existing pending usage records before deciding whether to create or update.

• Endpoint: GET /v2/usage-records
• Documentation: https://developer.zuora.com/quickstart-api/operation/getUsageRecords/

​

Payment Processing

​

Get Invoice

Used to retrieve invoice details (balance, status, currency) when processing a paid invoice webhook.

• Endpoint: GET /v1/object/invoice/{key} (via object queries)
• Documentation: https://developer.zuora.com/v1-api-reference/api/operation/Object_GETInvoice/

​

Get Invoice Items

Used to look up the subscription associated with an invoice when processing invoice-paid webhooks.

• Endpoint: GET /v1/invoices/{invoiceKey}/items
• Documentation: https://developer.zuora.com/v1-api-reference/api/operation/GET_InvoiceItems/

​

Create Payment

Used to mark an invoice as paid, either externally (for invoice-based billing) or electronically (via a payment gateway).

• Endpoint: POST /v1/payments
• Documentation: https://developer.zuora.com/v1-api-reference/api/operation/POST_CreatePayment/

​

Checkout & Hosted Payment Forms

Stigg supports Zuora’s hosted payment page (HPM) for collecting payment details without handling raw card data.

​

Get Hosted Page ID

Retrieves the available hosted payment page configuration to obtain the pageId required for payment form rendering.

• Endpoint: GET /v1/hostedpages
• Documentation: https://developer.zuora.com/v1-api-reference/api/operation/GET_HostedPages/

​

Generate RSA Signature

Generates a signed token for rendering the Zuora hosted payment form securely in the browser.

• Endpoint: POST /v1/rsa-signatures
• Documentation: https://developer.zuora.com/v1-api-reference/api/operation/POST_RsaSignatures/

​

Custom Field Management

Stigg provisions its own custom fields on Zuora objects (Account, Product, Subscription) to store Stigg metadata such as customer IDs and entity URLs.

​

Create / Update Custom Field Definitions

• Endpoint: PUT /objects/definitions/{object_type} (Custom Object Definitions API)
• Documentation: https://developer.zuora.com/v1-api-reference/api/operation/PUT_UpdateCustomObjectDefinition/

​

Webhook Setup

When a Zuora integration is created, Stigg automatically configures webhooks in Zuora so that billing events (subscription changes, invoice payments) are forwarded to Stigg in real time.

​

Custom Event Triggers

Stigg creates custom event triggers in Zuora that fire when specific subscription or account conditions are met.

• Endpoints:
  • POST /v1/events/event-triggers — create trigger
  • GET /v1/events/event-triggers — list triggers
  • DELETE /v1/events/event-triggers/{id} — delete trigger
• Documentation: https://developer.zuora.com/v1-api-reference/api/operation/POST_EventTrigger/

​

Callout Templates (Notifications)

Callouts define the HTTP request Zuora sends to Stigg’s incoming webhook URL when an event fires.

• Endpoints:
  • POST /v1/notifications/callout-templates — create callout
  • PUT /v1/notifications/callout-templates/{id} — update callout
  • GET /v1/notifications/callout-templates — list callouts
  • DELETE /v1/notifications/callout-templates/{id} — delete callout
• Documentation: https://developer.zuora.com/v1-api-reference/api/operation/POST_Create_Callout_Template/

​

Notification Definitions

Notification definitions link an event trigger to a callout template, activating the webhook delivery.

• Endpoints:
  • POST /v1/notifications/notification-definitions — create notification
  • GET /v1/notifications/notification-definitions — list notifications
  • DELETE /v1/notifications/notification-definitions/{id} — delete notification
• Documentation: https://developer.zuora.com/v1-api-reference/api/operation/POST_Create_Notification_Definition/

​

Settings

​

Get Payment Terms

Used to map Stigg’s invoiceDaysUntilDue setting to the matching Zuora payment term name when creating or updating a customer account.

• Endpoint: GET /v1/settings/payment-terms
• Documentation: https://developer.zuora.com/v1-api-reference/api/operation/GET_PaymentTerms/