api.md

Shared Params Types

• shared.BillingCycleRelativeDate

Shared Response Types

• shared.Discount
• shared.PaginationMetadata

TopLevel

Response Types:

• orb.TopLevelPingResponse

Methods:

• client.TopLevel.Ping(ctx context.Context) (orb.TopLevelPingResponse, error)

Coupons

Response Types:

• orb.Coupon

Methods:

• client.Coupons.New(ctx context.Context, body orb.CouponNewParams) (orb.Coupon, error)
• client.Coupons.List(ctx context.Context, query orb.CouponListParams) (pagination.Page[orb.Coupon], error)
• client.Coupons.Archive(ctx context.Context, couponID string) (orb.Coupon, error)
• client.Coupons.Fetch(ctx context.Context, couponID string) (orb.Coupon, error)

Subscriptions

Methods:

• client.Coupons.Subscriptions.List(ctx context.Context, couponID string, query orb.CouponSubscriptionListParams) (pagination.Page[orb.Subscription], error)

CreditNotes

Response Types:

• orb.CreditNote

Methods:

• client.CreditNotes.List(ctx context.Context, query orb.CreditNoteListParams) (pagination.Page[orb.CreditNote], error)
• client.CreditNotes.Fetch(ctx context.Context, creditNoteID string) (orb.CreditNote, error)

Customers

Response Types:

• orb.Customer

Methods:

• client.Customers.New(ctx context.Context, body orb.CustomerNewParams) (orb.Customer, error)
• client.Customers.Update(ctx context.Context, customerID string, body orb.CustomerUpdateParams) (orb.Customer, error)
• client.Customers.List(ctx context.Context, query orb.CustomerListParams) (pagination.Page[orb.Customer], error)
• client.Customers.Delete(ctx context.Context, customerID string) error
• client.Customers.Fetch(ctx context.Context, customerID string) (orb.Customer, error)
• client.Customers.FetchByExternalID(ctx context.Context, externalCustomerID string) (orb.Customer, error)
• client.Customers.UpdateByExternalID(ctx context.Context, id string, body orb.CustomerUpdateByExternalIDParams) (orb.Customer, error)

Costs

Response Types:

• orb.CustomerCostListResponse
• orb.CustomerCostListByExternalIDResponse

Methods:

• client.Customers.Costs.List(ctx context.Context, customerID string, query orb.CustomerCostListParams) (orb.CustomerCostListResponse, error)
• client.Customers.Costs.ListByExternalID(ctx context.Context, externalCustomerID string, query orb.CustomerCostListByExternalIDParams) (orb.CustomerCostListByExternalIDResponse, error)

Usage

Response Types:

• orb.CustomerUsageUpdateResponse
• orb.CustomerUsageUpdateByExternalIDResponse

Methods:

• client.Customers.Usage.Update(ctx context.Context, id string, params orb.CustomerUsageUpdateParams) (orb.CustomerUsageUpdateResponse, error)
• client.Customers.Usage.UpdateByExternalID(ctx context.Context, id string, params orb.CustomerUsageUpdateByExternalIDParams) (orb.CustomerUsageUpdateByExternalIDResponse, error)

Credits

Response Types:

• orb.CustomerCreditListResponse
• orb.CustomerCreditListByExternalIDResponse

Methods:

• client.Customers.Credits.List(ctx context.Context, customerID string, query orb.CustomerCreditListParams) (pagination.Page[orb.CustomerCreditListResponse], error)
• client.Customers.Credits.ListByExternalID(ctx context.Context, externalCustomerID string, query orb.CustomerCreditListByExternalIDParams) (pagination.Page[orb.CustomerCreditListByExternalIDResponse], error)

Ledger

Response Types:

• orb.CustomerCreditLedgerListResponse
• orb.CustomerCreditLedgerNewEntryResponse
• orb.CustomerCreditLedgerNewEntryByExternalIDResponse
• orb.CustomerCreditLedgerListByExternalIDResponse

Methods:

• client.Customers.Credits.Ledger.List(ctx context.Context, customerID string, query orb.CustomerCreditLedgerListParams) (pagination.Page[orb.CustomerCreditLedgerListResponse], error)
• client.Customers.Credits.Ledger.NewEntry(ctx context.Context, customerID string, body orb.CustomerCreditLedgerNewEntryParams) (orb.CustomerCreditLedgerNewEntryResponse, error)
• client.Customers.Credits.Ledger.NewEntryByExternalID(ctx context.Context, externalCustomerID string, body orb.CustomerCreditLedgerNewEntryByExternalIDParams) (orb.CustomerCreditLedgerNewEntryByExternalIDResponse, error)
• client.Customers.Credits.Ledger.ListByExternalID(ctx context.Context, externalCustomerID string, query orb.CustomerCreditLedgerListByExternalIDParams) (pagination.Page[orb.CustomerCreditLedgerListByExternalIDResponse], error)

TopUps

Response Types:

• orb.CustomerCreditTopUpNewResponse
• orb.CustomerCreditTopUpListResponse
• orb.CustomerCreditTopUpNewByExternalIDResponse
• orb.CustomerCreditTopUpListByExternalIDResponse

Methods:

• client.Customers.Credits.TopUps.New(ctx context.Context, customerID string, body orb.CustomerCreditTopUpNewParams) (orb.CustomerCreditTopUpNewResponse, error)
• client.Customers.Credits.TopUps.List(ctx context.Context, customerID string, query orb.CustomerCreditTopUpListParams) (pagination.Page[orb.CustomerCreditTopUpListResponse], error)
• client.Customers.Credits.TopUps.Delete(ctx context.Context, customerID string, topUpID string) error
• client.Customers.Credits.TopUps.NewByExternalID(ctx context.Context, externalCustomerID string, body orb.CustomerCreditTopUpNewByExternalIDParams) (orb.CustomerCreditTopUpNewByExternalIDResponse, error)
• client.Customers.Credits.TopUps.DeleteByExternalID(ctx context.Context, externalCustomerID string, topUpID string) error
• client.Customers.Credits.TopUps.ListByExternalID(ctx context.Context, externalCustomerID string, query orb.CustomerCreditTopUpListByExternalIDParams) (pagination.Page[orb.CustomerCreditTopUpListByExternalIDResponse], error)

BalanceTransactions

Response Types:

• orb.CustomerBalanceTransactionNewResponse
• orb.CustomerBalanceTransactionListResponse

Methods:

• client.Customers.BalanceTransactions.New(ctx context.Context, customerID string, body orb.CustomerBalanceTransactionNewParams) (orb.CustomerBalanceTransactionNewResponse, error)
• client.Customers.BalanceTransactions.List(ctx context.Context, customerID string, query orb.CustomerBalanceTransactionListParams) (pagination.Page[orb.CustomerBalanceTransactionListResponse], error)

Events

Response Types:

• orb.EventUpdateResponse
• orb.EventDeprecateResponse
• orb.EventIngestResponse
• orb.EventSearchResponse

Methods:

• client.Events.Update(ctx context.Context, eventID string, body orb.EventUpdateParams) (orb.EventUpdateResponse, error)
• client.Events.Deprecate(ctx context.Context, eventID string) (orb.EventDeprecateResponse, error)
• client.Events.Ingest(ctx context.Context, params orb.EventIngestParams) (orb.EventIngestResponse, error)
• client.Events.Search(ctx context.Context, body orb.EventSearchParams) (orb.EventSearchResponse, error)

Backfills

Response Types:

• orb.EventBackfillNewResponse
• orb.EventBackfillListResponse
• orb.EventBackfillCloseResponse
• orb.EventBackfillFetchResponse
• orb.EventBackfillRevertResponse

Methods:

• client.Events.Backfills.New(ctx context.Context, body orb.EventBackfillNewParams) (orb.EventBackfillNewResponse, error)
• client.Events.Backfills.List(ctx context.Context, query orb.EventBackfillListParams) (pagination.Page[orb.EventBackfillListResponse], error)
• client.Events.Backfills.Close(ctx context.Context, backfillID string) (orb.EventBackfillCloseResponse, error)
• client.Events.Backfills.Fetch(ctx context.Context, backfillID string) (orb.EventBackfillFetchResponse, error)
• client.Events.Backfills.Revert(ctx context.Context, backfillID string) (orb.EventBackfillRevertResponse, error)

InvoiceLineItems

Response Types:

• orb.InvoiceLineItemNewResponse

Methods:

• client.InvoiceLineItems.New(ctx context.Context, body orb.InvoiceLineItemNewParams) (orb.InvoiceLineItemNewResponse, error)

Invoices

Response Types:

• orb.Invoice
• orb.InvoiceFetchUpcomingResponse

Methods:

• client.Invoices.New(ctx context.Context, body orb.InvoiceNewParams) (orb.Invoice, error)
• client.Invoices.List(ctx context.Context, query orb.InvoiceListParams) (pagination.Page[orb.Invoice], error)
• client.Invoices.Fetch(ctx context.Context, invoiceID string) (orb.Invoice, error)
• client.Invoices.FetchUpcoming(ctx context.Context, query orb.InvoiceFetchUpcomingParams) (orb.InvoiceFetchUpcomingResponse, error)
• client.Invoices.Issue(ctx context.Context, invoiceID string) (orb.Invoice, error)
• client.Invoices.MarkPaid(ctx context.Context, invoiceID string, body orb.InvoiceMarkPaidParams) (orb.Invoice, error)
• client.Invoices.Void(ctx context.Context, invoiceID string) (orb.Invoice, error)

Items

Response Types:

• orb.Item

Methods:

• client.Items.New(ctx context.Context, body orb.ItemNewParams) (orb.Item, error)
• client.Items.Update(ctx context.Context, itemID string, body orb.ItemUpdateParams) (orb.Item, error)
• client.Items.List(ctx context.Context, query orb.ItemListParams) (pagination.Page[orb.Item], error)
• client.Items.Fetch(ctx context.Context, itemID string) (orb.Item, error)

Metrics

Response Types:

• orb.MetricNewResponse
• orb.MetricListResponse
• orb.MetricFetchResponse

Methods:

• client.Metrics.New(ctx context.Context, body orb.MetricNewParams) (orb.MetricNewResponse, error)
• client.Metrics.List(ctx context.Context, query orb.MetricListParams) (pagination.Page[orb.MetricListResponse], error)
• client.Metrics.Fetch(ctx context.Context, metricID string) (orb.MetricFetchResponse, error)

Plans

Response Types:

• orb.Plan

Methods:

• client.Plans.New(ctx context.Context, body orb.PlanNewParams) (orb.Plan, error)
• client.Plans.Update(ctx context.Context, planID string, body orb.PlanUpdateParams) (orb.Plan, error)
• client.Plans.List(ctx context.Context, query orb.PlanListParams) (pagination.Page[orb.Plan], error)
• client.Plans.Fetch(ctx context.Context, planID string) (orb.Plan, error)

ExternalPlanID

Methods:

• client.Plans.ExternalPlanID.Update(ctx context.Context, otherExternalPlanID string, body orb.PlanExternalPlanIDUpdateParams) (orb.Plan, error)
• client.Plans.ExternalPlanID.Fetch(ctx context.Context, externalPlanID string) (orb.Plan, error)

Prices

Response Types:

• orb.EvaluatePriceGroup
• orb.Price
• orb.PriceEvaluateResponse

Methods:

• client.Prices.New(ctx context.Context, body orb.PriceNewParams) (orb.Price, error)
• client.Prices.List(ctx context.Context, query orb.PriceListParams) (pagination.Page[orb.Price], error)
• client.Prices.Evaluate(ctx context.Context, priceID string, body orb.PriceEvaluateParams) (orb.PriceEvaluateResponse, error)
• client.Prices.Fetch(ctx context.Context, priceID string) (orb.Price, error)

ExternalPriceID

Methods:

• client.Prices.ExternalPriceID.Fetch(ctx context.Context, externalPriceID string) (orb.Price, error)

Subscriptions

Response Types:

• orb.Subscription
• orb.SubscriptionUsage
• orb.Subscriptions
• orb.SubscriptionFetchCostsResponse
• orb.SubscriptionFetchScheduleResponse

Methods:

• client.Subscriptions.New(ctx context.Context, body orb.SubscriptionNewParams) (orb.Subscription, error)
• client.Subscriptions.Update(ctx context.Context, subscriptionID string, body orb.SubscriptionUpdateParams) (orb.Subscription, error)
• client.Subscriptions.List(ctx context.Context, query orb.SubscriptionListParams) (pagination.Page[orb.Subscription], error)
• client.Subscriptions.Cancel(ctx context.Context, subscriptionID string, body orb.SubscriptionCancelParams) (orb.Subscription, error)
• client.Subscriptions.Fetch(ctx context.Context, subscriptionID string) (orb.Subscription, error)
• client.Subscriptions.FetchCosts(ctx context.Context, subscriptionID string, query orb.SubscriptionFetchCostsParams) (orb.SubscriptionFetchCostsResponse, error)
• client.Subscriptions.FetchSchedule(ctx context.Context, subscriptionID string, query orb.SubscriptionFetchScheduleParams) (pagination.Page[orb.SubscriptionFetchScheduleResponse], error)
• client.Subscriptions.FetchUsage(ctx context.Context, subscriptionID string, query orb.SubscriptionFetchUsageParams) (orb.SubscriptionUsage, error)
• client.Subscriptions.PriceIntervals(ctx context.Context, subscriptionID string, body orb.SubscriptionPriceIntervalsParams) (orb.Subscription, error)
• client.Subscriptions.SchedulePlanChange(ctx context.Context, subscriptionID string, body orb.SubscriptionSchedulePlanChangeParams) (orb.Subscription, error)
• client.Subscriptions.TriggerPhase(ctx context.Context, subscriptionID string, body orb.SubscriptionTriggerPhaseParams) (orb.Subscription, error)
• client.Subscriptions.UnscheduleCancellation(ctx context.Context, subscriptionID string) (orb.Subscription, error)
• client.Subscriptions.UnscheduleFixedFeeQuantityUpdates(ctx context.Context, subscriptionID string, body orb.SubscriptionUnscheduleFixedFeeQuantityUpdatesParams) (orb.Subscription, error)
• client.Subscriptions.UnschedulePendingPlanChanges(ctx context.Context, subscriptionID string) (orb.Subscription, error)
• client.Subscriptions.UpdateFixedFeeQuantity(ctx context.Context, subscriptionID string, body orb.SubscriptionUpdateFixedFeeQuantityParams) (orb.Subscription, error)

Webhooks

Methods:

• client.Webhooks.VerifySignature(payload []byte, headers http.Header, secret string, now time.Time) error

Alerts

Response Types:

• orb.Alert

Methods:

• client.Alerts.Get(ctx context.Context, alertID string) (orb.Alert, error)
• client.Alerts.List(ctx context.Context, query orb.AlertListParams) (pagination.Page[orb.Alert], error)
• client.Alerts.NewForCustomer(ctx context.Context, customerID string, body orb.AlertNewForCustomerParams) (orb.Alert, error)
• client.Alerts.NewForExternalCustomer(ctx context.Context, externalCustomerID string, body orb.AlertNewForExternalCustomerParams) (orb.Alert, error)
• client.Alerts.NewForSubscription(ctx context.Context, subscriptionID string, body orb.AlertNewForSubscriptionParams) (orb.Alert, error)
• client.Alerts.Disable(ctx context.Context, alertConfigurationID string) (orb.Alert, error)
• client.Alerts.Enable(ctx context.Context, alertConfigurationID string) (orb.Alert, error)