Expand description
An async API client for the Orb billing platform.
§Maintainership
This is not an official Orb product. This crate is developed by Materialize, the streaming data warehouse. Contributions are encouraged:
§See also
Additional information is available in the official Orb API documentation.
Structs§
- AddIncrement
Credit Ledger Entry Request Params - The parameters used to create a customer credit ledger entry.
- AddVoid
Credit Ledger Entry Request Params - The parameters used to void a customer credit ledger entry.
- Address
- A customer’s address.
- Address
Request - The subset of
Addressused in create and update requests. - Amend
Event Request - The subset of
Eventused in amendment requests. - ApiError
- An error returned by the Orb API.
- Client
- An API client for Orb.
- Client
Builder - A builder for a
Client. - Client
Config - Configures the required parameters of a
Client. - Create
Customer Request - The subset of
Customerused in create requests. - Create
Subscription Request - An Orb subscription.
- Credit
Ledger Invoice Settings Request Params - Optional invoicing settings for a credit purchase.
- Customer
- An Orb customer.
- Customer
Cost Bucket - A group of costs for a given timeframe.
- Customer
Cost Item - An item being priced.
- Customer
Cost Params - Parameters for a Customer Costs query.
- Customer
Cost Price Block - The cost for a given Price within a timeframe.
- Customer
Cost Price Block Matrix Price - Matrix pricing details.
- Customer
Cost Price Block Matrix Price Config - Configuration for a pricing matrix.
- Customer
Cost Price Block Matrix Price Value - A pricing value for a cell within the pricing matrix.
- Customer
Cost Price Block Price Group - A price cost for a given set of grouping keys.
- Customer
Cost Price Block Unit Price - Unit pricing details.
- Customer
Cost Price Block Unit Price Config - Configuration for a unit price.
- Customer
Credit Block - A block of credit held by a customer.
- Customer
Payment Provider Request - Configures an external payment or invoicing solution for a customer.
- Event
- An Orb event.
- Event
Search Params - Parameters for an event search operation.
- Ingest
Event Debug Response - The type of
IngestEventResponse::debug. - Ingest
Event Request - The subset of
Eventused in event ingestion requests. - Ingest
Event Response - The response to an event ingestion request.
- Invoice
- An Orb invoice.
- Invoice
Customer - Identifies the customer associated with an
Invoice. - Invoice
List Params - Parameters for a subscription list operation.
- Invoice
Status Filter - Identifies the statuses of which
Invoices should be returned. - Invoice
Subscription - Identifies the subscription associated with an
Invoice. - List
Params - Parameters for a list operation.
- Plan
- An Orb plan.
- Subscription
- An Orb subscription.
- Subscription
List Params - Parameters for a subscription list operation.
- TaxId
- Tax ID details to display on an invoice.
- TaxId
Request - The subset of
TaxIdused in create and update requests. - Update
Customer Request - The subset of
Customerused in update requests.
Enums§
- Cost
View Mode - The view mode for a cost breakdown.
- Customer
Cost Price Block Price - The type of pricing
- Customer
Id - A customer ID.
- Error
- An error returned by a
Client. - Event
Property Value - The value of a property assocaited with an
Event. - External
Marketplace - An external marketplace to which subscriptions can be attached.
- Ingestion
Mode - The ingestion mode.
- Ledger
Entry - The type of ledger entry
- Ledger
Entry Request - The types of ledger entries that can be created.
- Payment
Provider - A payment provider.
- PlanId
- A plan ID.
- Subscription
Status - The status of an Orb subscription.
- TaxId
Type - The type of a
TaxId. - Void
Reason - The reason for a void operation.