All integrationsPayments & Billing

Orb

Manage customers, subscriptions, invoices and usage events in Orb.

actions
20
triggers
6

Triggers

Start a workflow when something happens in Orb.

  • New customerRuns for each new customer in Orb. Ones already there when the workflow is turned on don't start it. It can watch up to 4,000. How often it checks follows your workspace plan.
  • New subscriptionRuns for each new subscription in Orb. Ones already there when the workflow is turned on don't start it. It can watch up to 4,000. How often it checks follows your workspace plan.
  • Subscription status changedRuns each time a subscription status changes in Orb. Changes made before the workflow is turned on don't start it. It can watch up to 4,000. How often it checks follows your workspace plan.
  • New invoiceRuns for each new invoice in Orb. Ones already there when the workflow is turned on don't start it. It can watch up to 4,000. How often it checks follows your workspace plan.
  • Invoice paidRuns each time an invoice is paid in Orb. Ones paid before the workflow is turned on don't start it. It can watch up to 4,000. How often it checks follows your workspace plan.
  • Invoice status changedRuns each time an invoice status changes in Orb. Changes made before the workflow is turned on don't start it. It can watch up to 4,000. How often it checks follows your workspace plan.

Actions

Steps a workflow can run in Orb.

  • Check connectionThis endpoint allows you to test your connection to the Orb API and check the validity of your API key, passed in the Authorization header. This is particularly useful for checking that your environment is set up properly, and is a great choice for connectors and integrations.
  • List customersThis endpoint returns a list of all customers for an account. The list of customers is ordered starting from the most recently created customer. This endpoint follows Orb's standardized pagination format.
  • Create customerThis operation is used to create an Orb customer, who is party to the core billing relationship. See Customer for an overview of the customer resource.
  • Get customerThis endpoint is used to fetch customer details given an identifier. If the Customer is in the process of being deleted, only the properties id and deleted: true will be returned.
  • Get customer by external IDThis endpoint is used to fetch customer details given an external_customer_id (see Customer ID Aliases).
  • Update customerUpdate the customer fields you fill in. Orb keeps the other fields.
  • Delete customerThis performs a deletion of this customer, its subscriptions, and its invoices, provided the customer does not have any issued invoices. Customers with issued invoices cannot be deleted. This operation is irreversible. Note that this is a _soft_ deletion, but the data will…
  • List plansThis endpoint returns a list of all plans for an account in a list format. The list of plans is ordered starting from the most recently created plan. The response also includes pagination_metadata which lets the caller retrieve the next page of results if they exist.
  • Get planThis endpoint is used to fetch plan details given a plan identifier. It returns information about the prices included in the plan and their configuration, as well as the product that the plan is attached to.
  • List pricesThis endpoint is used to list all add-on prices created using the price creation endpoint.
  • List subscriptionsThis endpoint returns a list of all subscriptions for an account as a paginated list, ordered starting from the most recently created subscription. For a full discussion of the subscription resource, see Subscription.
  • Get subscriptionThis endpoint is used to fetch a Subscription given an identifier.
  • Create subscriptionA subscription represents the purchase of a plan by a customer. The customer is identified by either the customer_id or the external_customer_id, and exactly one of these fields must be provided.
  • Cancel subscriptionThis endpoint can be used to cancel an existing subscription. It returns the serialized subscription object with an end_date parameter that signifies when the subscription will transition to an ended state.
  • Get subscription usageThis endpoint is used to fetch a subscription's usage in Orb. Especially when combined with optional query parameters, this endpoint is a powerful way to build visualizations on top of Orb's event data and metrics.
  • List invoicesThis endpoint returns a list of all Invoices for an account in a list format.
  • Get invoiceThis endpoint is used to fetch an Invoice given an identifier.
  • Get upcoming invoiceThis endpoint can be used to fetch the upcoming invoice for the current billing period given a subscription.
  • List customer credit blocksReturns a paginated list of unexpired, non-zero credit blocks for a customer.
  • Send usage eventsOrb's event ingestion model and API is designed around two core principles:

Automate Orb with Lodol.

Connect Orb, then hand Lodol the job in Slack, Claude or ChatGPT.

We’re letting people in a few at a time.