Description | Orb API Endpoints | |
---|---|---|
Provision new contracts | A new Enterprise contract is sold to an existing customer on a self-serve paid plan, an existing user of the free plan, or to a net new user. | In flow builder, fetch or create an Orb customer. When a customer does not have an existing Orb subscription, use Create subscription: - Equivalent APEX action: OrbCreateSubscription - API docs When a customer does have an existing Orb subscription, Schedule plan change: - Equivalent APEX action: OrbSchedulePlanChange - API docs |
Amend an existing contract | An existing contract is amended (edited), usually in an upsell or revision scenario. Often the following is amended: - Usage quantities: Increasing usage commits or decreasing them - Adding new products within the contract term | The APEX actions used depend on the contract changes made. Update fixed-fee quantity: - This is specifically for cases where you need to update a quantity on a non-usage-based fee; allocations are a special kind of non-usage-based fee, so allocation amounts can be updated this way - Equivalent APEX action: OrbUpdatePriceQuantity - API docs Add and edit price intervals: - This endpoint lets you end prices on the subscription at specific dates, and add new ones - These changes can be backdated or forward-dated - Ending a price interval, and adding a new one with similar-but-different configuration, is the common way to “amend” a particular price point - Equivalent APEX action: OrbAddEditPriceIntervals - API docs |
Cancel and replace an existing contract | An existing contract is canceled and replaced. Typically this is an upsell scenario, if a customer is growing in their usage, they want to negotiate a cheaper rate. | You’ll likely model this with a plan change, scheduled at the time of the transition to the new contract (note: this can be backdated or forward-dated). - Equivalent APEX action: OrbSchedulePlanChange - API docs |
Renew contracts | At the end of the contract term, the sales person will negotiate and provision a new contract. | You might model this as: A plan change: - Equivalent APEX action: OrbSchedulePlanChange - API docs A cancellation, plus a new subscription (in the event it’s a “new billing relationship” - e.g., with M&A): - Equivalent APEX actions: OrbCancelSubscription , OrbCreateSubscription - API docs for cancellation - API docs for creation |
Early termination | An enterprise customer ends a contract prior to the end of term and is no longer a customer or is moved to an existing paid or free plan. | You’ll likely model this as either a cancellation (churn): - Equivalent APEX action: OrbCancelSubscription - API docs Or a plan change (downgrade): - Equivalent APEX action: OrbSchedulePlanChange - API docs Orb will track prorated refunds for in-advance fees, but won’t issue them automatically - you’ll need to disburse those funds manually in the case of a prorated refund. |
Include a Run Asynchronously path...
checkbox at the bottom when creating the Flow. This allows you to use the Orb actions.
Run Asynchronously
path, add an Action and search for the Create Orb Customer
action
Address
variable, create an Assignment
with a data type of Apex-Defined
. Search for the withorb__OrbAddressInput
Apex class, and fill in fields as needed.
Create Orb Customer
action.
Create Orb Subscription
action. Similar to customer, fill in the appropriate fields.
withorb__OrbPriceOverride
and fill in appropriate fields. This data is normally stored on the Opportunity Line Item.