Crate orb_billing

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:

• View source code
• Report an issue
• Submit a pull request

See also

Additional information is available in the official Orb API documentation.

Structs

• AddIncrementCreditLedgerEntryRequestParams
  The parameters used to create a customer credit ledger entry.
• AddVoidCreditLedgerEntryRequestParams
  The parameters used to void a customer credit ledger entry.
• Address
  A customer’s address.
• AddressRequest
  The subset of Address used in create and update requests.
• AmendEventRequest
  The subset of Event used in amendment requests.
• ApiError
  An error returned by the Orb API.
• Client
  An API client for Orb.
• ClientBuilder
  A builder for a Client.
• ClientConfig
  Configures the required parameters of a Client.
• CreateCustomerRequest
  The subset of Customer used in create requests.
• CreateSubscriptionRequest
  An Orb subscription.
• CreditLedgerInvoiceSettingsRequestParams
  Optional invoicing settings for a credit purchase.
• Customer
  An Orb customer.
• CustomerCostBucket
  A group of costs for a given timeframe.
• CustomerCostItem
  An item being priced.
• CustomerCostParams
  Parameters for a Customer Costs query.
• CustomerCostPriceBlock
  The cost for a given Price within a timeframe.
• CustomerCostPriceBlockMatrixPrice
  Matrix pricing details.
• CustomerCostPriceBlockMatrixPriceConfig
  Configuration for a pricing matrix.
• CustomerCostPriceBlockMatrixPriceValue
  A pricing value for a cell within the pricing matrix.
• CustomerCostPriceBlockPriceGroup
  A price cost for a given set of grouping keys.
• CustomerCostPriceBlockUnitPrice
  Unit pricing details.
• CustomerCostPriceBlockUnitPriceConfig
  Configuration for a unit price.
• CustomerCreditBlock
  A block of credit held by a customer.
• CustomerPaymentProviderRequest
  Configures an external payment or invoicing solution for a customer.
• Event
  An Orb event.
• EventSearchParams
  Parameters for an event search operation.
• IngestEventDebugResponse
  The type of IngestEventResponse::debug.
• IngestEventRequest
  The subset of Event used in event ingestion requests.
• IngestEventResponse
  The response to an event ingestion request.
• Invoice
  An Orb invoice.
• InvoiceCustomer
  Identifies the customer associated with an Invoice.
• InvoiceListParams
  Parameters for a subscription list operation.
• InvoiceStatusFilter
  Identifies the statuses of which Invoices should be returned.
• InvoiceSubscription
  Identifies the subscription associated with an Invoice.
• ListParams
  Parameters for a list operation.
• Plan
  An Orb plan.
• Subscription
  An Orb subscription.
• SubscriptionListParams
  Parameters for a subscription list operation.
• TaxId
  Tax ID details to display on an invoice.
• TaxIdRequest
  The subset of TaxId used in create and update requests.
• UpdateCustomerRequest
  The subset of Customer used in update requests.

Enums

• CostViewMode
  The view mode for a cost breakdown.
• CustomerCostPriceBlockPrice
  The type of pricing
• CustomerId
  A customer ID.
• Error
  An error returned by a Client.
• EventPropertyValue
  The value of a property assocaited with an Event.
• ExternalMarketplace
  An external marketplace to which subscriptions can be attached.
• IngestionMode
  The ingestion mode.
• LedgerEntry
  The type of ledger entry
• LedgerEntryRequest
  The types of ledger entries that can be created.
• PaymentProvider
  A payment provider.
• PlanId
  A plan ID.
• SubscriptionStatus
  The status of an Orb subscription.
• TaxIdType
  The type of a TaxId.
• VoidReason
  The reason for a void operation.