Orb is a usage-based billing platform for subscription pricing, invoicing, and revenue metrics. Nexla connects to the Orb REST API so you can ingest billing objects such as alerts, coupons, credit blocks, and credit notes, and push changes back to manage alerts and coupons. Authentication uses an Orb API key sent as a Bearer token.
Power end-to-end data operations for your Orb API with Nexla. Our bi-directional Orb connector is purpose-built for Orb, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Orb or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Orb workflows fast, secure, and fully governed.
Features
Type: API
SourceDestination
Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
Request optimization with intelligent batching, retry, and caching to minimize API calls and costs
Before creating an Orb credential, you need an Orb API key. Orb authenticates every API request with an API key passed as a Bearer token in the Authorization header (Authorization: Bearer YOUR_API_KEY).
Enter a name and an optional description for the key, then click Create.
Copy the generated API key immediately and store it securely. Orb displays the full key only once, so you will not be able to view it again after leaving the page.
Orb also lets you create keys from Organization Settings if the Developers tab is not available for your account. Treat the API key as a secret: it grants access to your Orb billing data, and if it is compromised you should revoke it in the Orb dashboard and generate a new one. For more detail on authentication and the available endpoints, see the Orb API documentation.
After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.
Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.
Enter your Orb API key in the API Key Value field. This is the key you generated in Prerequisites. Nexla sends it as a Bearer token in the Authorization header on every request to the Orb API, so it must be kept confidential.
If your API key is compromised, revoke it in the Orb dashboard under Developers > API Keys and generate a new one. For more information about authentication and the Orb API, see the Orb API documentation.
Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.
To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Orb connector tile, then select the credential that will be used to connect to Orb, and click Next; or, create a new Orb credential for use in this flow.
Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Orb endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.
[Rest API] List alerts
This endpoint template retrieves a list of alerts configured in your Orb account. Use it to ingest alert configurations for reporting or to audit which usage and spend alerts are active.
Sends a GET request to https://api.withorb.com/v1/alerts and reads records from the data array in the response. Optional query parameters such as customer_id, external_customer_id, subscription_id, and created_at filters can be supplied to narrow the results.
For details about the alert object and its query parameters, see the Orb API documentation.
[Rest API] Fetch alert
This endpoint template retrieves a single alert by its ID. Use it when you need the full configuration of one specific alert.
Sends a GET request to https://api.withorb.com/v1/alerts/{alert_id}. Provide the Alert Id path parameter to identify the alert to fetch.
This endpoint template retrieves a list of coupons in your Orb account. Use it to ingest coupon definitions, including discounts and redemption limits, for analysis or reconciliation.
Sends a GET request to https://api.withorb.com/v1/coupons and reads records from the data array. Optional query parameters include show_archived and redemption_code.
For details about the coupon object and its query parameters, see the Orb API documentation.
[Rest API] Fetch coupon
This endpoint template retrieves a single coupon by its ID. Use it when you need the full definition of one specific coupon.
Sends a GET request to https://api.withorb.com/v1/coupons/{coupon_id}. Provide the Coupon Id path parameter to identify the coupon to fetch.
This endpoint template retrieves the subscriptions that have redeemed a given coupon. Use it to understand which customers are using a coupon.
Sends a GET request to https://api.withorb.com/v1/coupons/{coupon_id}/subscriptions and reads records from the data array. Provide the Coupon Id path parameter; optional limit and cursor parameters control paging.
This endpoint template retrieves the invoices associated with a given credit block. Use it to trace how a credit block has been applied across invoices.
Sends a GET request to https://api.withorb.com/v1/credit_blocks/{block_id}/invoices and reads records from the invoices array. Provide the Block Id path parameter to identify the credit block.
This endpoint template retrieves a list of credit notes in your Orb account. Use it to ingest credit note records for revenue and refund reporting.
Sends a GET request to https://api.withorb.com/v1/credit_notes and reads records from the data array. Optional query parameters such as limit and cursor control paging.
This endpoint template creates a credit note in Orb and returns the created record. It is configured as a source so the response can be captured into a Nexset in the same flow.
Sends a POST request to https://api.withorb.com/v1/credit_notes with a JSON body built from the Line Items, Reason, Memo, Start Date, and End Date parameters.
For the required request body fields and their formats, see the Orb API documentation.
[Rest API] Fetch credit note
This endpoint template retrieves a single credit note by its ID. Use it when you need the full detail of one specific credit note.
Sends a GET request to https://api.withorb.com/v1/credit_notes/{credit_note_id}. Provide the Credit Note Id path parameter to identify the credit note to fetch.
Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.
Orb data sources can also be manually configured to ingest data from any valid Orb API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.
Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Orb data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.
Click the + icon on the Nexset that will be sent to the Orb destination, and select the Send to Destination option from the menu. Select the Orb connector from the list of available destination connectors, then select the credential that will be used to connect to Orb, and click Next; or, create a new Orb credential for use in this flow.
Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Orb endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.
[Rest API] Create customer alert
This endpoint template creates a new alert for a customer identified by their Orb customer ID, using records from a Nexset.
Sends a POST request to https://api.withorb.com/v1/alerts/customer_id/{customer_id} with the record as a JSON body. Provide the Customer Id path parameter; the body carries fields such as Thresholds, Type, and Currency.
For the required request body fields and their formats, see the Orb API documentation.
[Rest API] Create customer alert by external ID
This endpoint template creates a new alert for a customer identified by your own external customer ID, using records from a Nexset.
Sends a POST request to https://api.withorb.com/v1/alerts/external_customer_id/{external_customer_id} with the record as a JSON body. Provide the External Customer Id path parameter; the body carries fields such as Thresholds, Type, and Currency.
For the required request body fields and their formats, see the Orb API documentation.
[Rest API] Create subscription alert
This endpoint template creates a new alert on a subscription, using records from a Nexset.
Sends a POST request to https://api.withorb.com/v1/alerts/subscription_id/{subscription_id} with the record as a JSON body. Provide the Subscription Id path parameter; the body carries fields such as Thresholds, Type, Metric Id, Grouping Keys, Currency, Price Filters, and Threshold Overrides.
For the required request body fields and their formats, see the Orb API documentation.
[Rest API] Update alert
This endpoint template updates an existing alert by its configuration ID, using records from a Nexset.
Sends a PUT request to https://api.withorb.com/v1/alerts/{alert_configuration_id} with the record as a JSON body. Provide the Alert Configuration Id path parameter; the body carries fields such as Thresholds, Price Filters, and Threshold Overrides.
For the required request body fields and their formats, see the Orb API documentation.
[Rest API] Trash alert
This endpoint template deletes (trashes) an alert by its configuration ID, using records from a Nexset.
Sends a DELETE request to https://api.withorb.com/v1/alerts/{alert_configuration_id}. Provide the Alert Configuration Id path parameter to identify the alert to remove.
This endpoint template disables an alert by its configuration ID, using records from a Nexset.
Sends a POST request to https://api.withorb.com/v1/alerts/{alert_configuration_id}/disable. Provide the Alert Configuration Id path parameter; the optional Subscription Id query parameter scopes the change to a specific subscription.
This endpoint template enables an alert by its configuration ID, using records from a Nexset.
Sends a POST request to https://api.withorb.com/v1/alerts/{alert_configuration_id}/enable. Provide the Alert Configuration Id path parameter; the optional Subscription Id query parameter scopes the change to a specific subscription.
This endpoint template creates a new coupon in Orb, using records from a Nexset.
Sends a POST request to https://api.withorb.com/v1/coupons with the record as a JSON body. The body carries fields such as Redemption Code, Discount, Duration In Months, and Max Redemptions.
For the required request body fields and their formats, see the Orb API documentation.
[Rest API] Archive coupon
This endpoint template archives a coupon by its ID so it can no longer be redeemed, using records from a Nexset.
Sends a POST request to https://api.withorb.com/v1/coupons/{coupon_id}/archive. Provide the Coupon Id path parameter to identify the coupon to archive.
This endpoint template deletes a credit block by its ID, using records from a Nexset.
Sends a DELETE request to https://api.withorb.com/v1/credit_blocks/{block_id}. Provide the Block Id path parameter to identify the credit block to remove.
Orb destinations can also be manually configured to send data to any valid Orb API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.
Orb APIs expect JSON in the request body for create and update operations. For operations that act on a specific object, include the object's ID in the endpoint URL path.
Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Orb endpoint, open the destination resource menu, and select Activate.
The Nexset data will not be sent to the Orb endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.
