openmeter

type APIError struct {
	// StatusCode is the HTTP status code of the response.
	StatusCode int `json:"-"`

	// Status is the status code echoed in the problem body (usually equal to
	// StatusCode).
	Status int `json:"status"`
	// Title is a short, stable, human-readable summary of the problem.
	Title string `json:"title"`
	// Type is an optional machine-readable error type.
	Type string `json:"type,omitempty"`
	// Detail is a human-readable explanation specific to this occurrence.
	Detail string `json:"detail"`
	// Instance carries the correlation ID, formatted as kong:trace:<id>.
	Instance string `json:"instance"`

	// RawBody is the undecoded response body, always populated.
	RawBody []byte `json:"-"`
}

type Addon struct {
	ID string `json:"id"`
	// Display name of the resource.
	//
	// Between 1 and 256 characters.
	Name string `json:"name"`
	// Optional description of the resource.
	//
	// Maximum 1024 characters.
	Description *string           `json:"description,omitempty"`
	Labels      map[string]string `json:"labels,omitempty"`
	// An ISO-8601 timestamp representation of entity creation date.
	CreatedAt time.Time `json:"created_at"`
	// An ISO-8601 timestamp representation of entity last update date.
	UpdatedAt time.Time `json:"updated_at"`
	// An ISO-8601 timestamp representation of entity deletion date.
	DeletedAt *time.Time `json:"deleted_at,omitempty"`
	// A key is a semi-unique string that is used to identify the add-on. It is used to
	// reference the latest `active` version of the add-on and is unique with the
	// version number.
	Key string `json:"key"`
	// Version of the add-on. Incremented when the add-on is updated.
	Version int64 `json:"version"`
	// The InstanceType of the add-ons. Can be "single" or "multiple".
	InstanceType AddonInstanceType `json:"instance_type"`
	// The currency code of the add-on.
	Currency BillingCurrencyCode `json:"currency"`
	// The date and time when the add-on becomes effective. When not specified, the
	// add-on is a draft.
	EffectiveFrom *time.Time `json:"effective_from,omitempty"`
	// The date and time when the add-on is no longer effective. When not specified,
	// the add-on is effective indefinitely.
	EffectiveTo *time.Time `json:"effective_to,omitempty"`
	// The status of the add-on. Computed based on the effective start and end dates:
	//
	// - `draft`: `effective_from` is not set.
	// - `active`: `effective_from <= now` and (`effective_to` is not set or
	// `now < effective_to`).
	// - `archived`: `effective_to <= now`.
	Status AddonStatus `json:"status"`
	// The rate cards of the add-on.
	RateCards []RateCard `json:"rate_cards"`
	// List of validation errors.
	ValidationErrors []ProductCatalogValidationError `json:"validation_errors,omitempty"`
}

type AddonFilter struct {
	ID       *StringExactFilter
	Key      *StringFilter
	Name     *StringFilter
	Status   *StringExactFilter
	Currency *StringExactFilter
}

type AddonInstanceType string

type AddonListParams struct {
	Page   *PageParams
	Sort   *Sort
	Filter *AddonFilter
}

type AddonPagePaginatedResponse struct {
	Data []Addon       `json:"data"`
	Meta PaginatedMeta `json:"meta"`
}

type AddonReference struct {
	ID string `json:"id"`
}

type AddonStatus string

type AddonsService struct {
	// contains filtered or unexported fields
}

type Address struct {
	// Country code in [ISO 3166-1](https://www.iso.org/iso-3166-country-codes.html)
	// alpha-2 format.
	Country *string `json:"country,omitempty"`
	// Postal code.
	PostalCode *string `json:"postal_code,omitempty"`
	// State or province.
	State *string `json:"state,omitempty"`
	// City.
	City *string `json:"city,omitempty"`
	// First line of the address.
	Line1 *string `json:"line1,omitempty"`
	// Second line of the address.
	Line2 *string `json:"line2,omitempty"`
	// Phone number.
	PhoneNumber *string `json:"phone_number,omitempty"`
}

type App struct {
	Type string `json:"type"`
	// contains filtered or unexported fields
}

type AppCapability struct {
	// Type of the capability.
	Type AppCapabilityType `json:"type"`
	// Key of the capability.
	Key string `json:"key"`
	// Name of the capability.
	Name string `json:"name"`
	// Description of the capability.
	Description string `json:"description"`
}

type AppCapabilityType string

type AppCatalogItem struct {
	// Type of the app.
	Type AppType `json:"type"`
	// Name of the app.
	Name string `json:"name"`
	// Description of the app.
	Description string `json:"description"`
	// Capabilities of the app.
	Capabilities []AppCapability `json:"capabilities"`
	// Available install methods of the app.
	InstallMethods []AppInstallMethods `json:"install_methods"`
}

type AppCatalogItemListParams struct {
	Page *PageParams
}

type AppCatalogItemPagePaginatedResponse struct {
	Data []AppCatalogItem `json:"data"`
	Meta PaginatedMeta    `json:"meta"`
}

type AppCustomerData struct {
	// Used if the customer has a linked Stripe app.
	//
	// Set to `null` to remove the Stripe data of the customer; omit to leave it
	// unchanged.
	Stripe Nullable[AppCustomerDataStripe] `json:"stripe,omitempty"`
	// Used if the customer has a linked external invoicing app.
	//
	// Set to `null` to remove the external invoicing data of the customer; omit to
	// leave it unchanged.
	ExternalInvoicing Nullable[AppCustomerDataExternalInvoicing] `json:"external_invoicing,omitempty"`
}

type AppCustomerDataExternalInvoicing struct {
	// Labels for this external invoicing integration on the customer.
	Labels map[string]string `json:"labels,omitempty"`
}

type AppCustomerDataExternalInvoicingInput struct {
	// Labels for this external invoicing integration on the customer.
	Labels *map[string]string `json:"labels,omitempty"`
}

type AppCustomerDataInput struct {
	// Used if the customer has a linked Stripe app.
	//
	// Set to `null` to remove the Stripe data of the customer; omit to leave it
	// unchanged.
	Stripe Nullable[AppCustomerDataStripeInput] `json:"stripe,omitempty"`
	// Used if the customer has a linked external invoicing app.
	//
	// Set to `null` to remove the external invoicing data of the customer; omit to
	// leave it unchanged.
	ExternalInvoicing Nullable[AppCustomerDataExternalInvoicingInput] `json:"external_invoicing,omitempty"`
}

type AppCustomerDataStripe struct {
	// The Stripe customer ID used.
	CustomerID *string `json:"customer_id,omitempty"`
	// The Stripe default payment method ID.
	DefaultPaymentMethodID *string `json:"default_payment_method_id,omitempty"`
	// Labels for this Stripe integration on the customer.
	Labels map[string]string `json:"labels,omitempty"`
}

type AppCustomerDataStripeInput struct {
	// The Stripe customer ID used.
	CustomerID *string `json:"customer_id,omitempty"`
	// The Stripe default payment method ID.
	DefaultPaymentMethodID *string `json:"default_payment_method_id,omitempty"`
	// Labels for this Stripe integration on the customer.
	Labels *map[string]string `json:"labels,omitempty"`
}

type AppExternalInvoicing struct {
	ID string `json:"id"`
	// Display name of the resource.
	//
	// Between 1 and 256 characters.
	Name string `json:"name"`
	// Optional description of the resource.
	//
	// Maximum 1024 characters.
	Description *string           `json:"description,omitempty"`
	Labels      map[string]string `json:"labels,omitempty"`
	// An ISO-8601 timestamp representation of entity creation date.
	CreatedAt time.Time `json:"created_at"`
	// An ISO-8601 timestamp representation of entity last update date.
	UpdatedAt time.Time `json:"updated_at"`
	// An ISO-8601 timestamp representation of entity deletion date.
	DeletedAt *time.Time `json:"deleted_at,omitempty"`
	// The app type.
	Type AppType `json:"type"`
	// The app catalog definition that this installed app is based on.
	Definition AppCatalogItem `json:"definition"`
	// Status of the app connection.
	Status AppStatus `json:"status"`
	// Enable draft synchronization hook.
	//
	// When enabled, invoices will pause at the draft state and wait for the
	// integration to call the draft synchronized endpoint before progressing to the
	// issuing state. This allows the external system to validate and prepare the
	// invoice data.
	//
	// When disabled, invoices automatically progress through the draft state based on
	// the configured workflow timing.
	EnableDraftSyncHook bool `json:"enable_draft_sync_hook"`
	// Enable issuing synchronization hook.
	//
	// When enabled, invoices will pause at the issuing state and wait for the
	// integration to call the issuing synchronized endpoint before progressing to the
	// issued state. This ensures the external invoicing system has successfully
	// created and finalized the invoice before it is marked as issued.
	//
	// When disabled, invoices automatically progress through the issuing state and are
	// immediately marked as issued.
	EnableIssuingSyncHook bool `json:"enable_issuing_sync_hook"`
}

type AppFilter struct {
	ID     *StringExactFilter
	Name   *StringFilter
	Type   *StringExactFilter
	Status *StringExactFilter
}

type AppInstallMethods string

type AppListParams struct {
	Page   *PageParams
	Sort   *Sort
	Filter *AppFilter
}

type AppPagePaginatedResponse struct {
	Data []App         `json:"data"`
	Meta PaginatedMeta `json:"meta"`
}

type AppReference struct {
	// The ID of the app.
	ID string `json:"id"`
}

type AppSandbox struct {
	ID string `json:"id"`
	// Display name of the resource.
	//
	// Between 1 and 256 characters.
	Name string `json:"name"`
	// Optional description of the resource.
	//
	// Maximum 1024 characters.
	Description *string           `json:"description,omitempty"`
	Labels      map[string]string `json:"labels,omitempty"`
	// An ISO-8601 timestamp representation of entity creation date.
	CreatedAt time.Time `json:"created_at"`
	// An ISO-8601 timestamp representation of entity last update date.
	UpdatedAt time.Time `json:"updated_at"`
	// An ISO-8601 timestamp representation of entity deletion date.
	DeletedAt *time.Time `json:"deleted_at,omitempty"`
	// The app type.
	Type AppType `json:"type"`
	// The app catalog definition that this installed app is based on.
	Definition AppCatalogItem `json:"definition"`
	// Status of the app connection.
	Status AppStatus `json:"status"`
}

type AppStatus string

type AppStripe struct {
	ID string `json:"id"`
	// Display name of the resource.
	//
	// Between 1 and 256 characters.
	Name string `json:"name"`
	// Optional description of the resource.
	//
	// Maximum 1024 characters.
	Description *string           `json:"description,omitempty"`
	Labels      map[string]string `json:"labels,omitempty"`
	// An ISO-8601 timestamp representation of entity creation date.
	CreatedAt time.Time `json:"created_at"`
	// An ISO-8601 timestamp representation of entity last update date.
	UpdatedAt time.Time `json:"updated_at"`
	// An ISO-8601 timestamp representation of entity deletion date.
	DeletedAt *time.Time `json:"deleted_at,omitempty"`
	// The app type.
	Type AppType `json:"type"`
	// The app catalog definition that this installed app is based on.
	Definition AppCatalogItem `json:"definition"`
	// Status of the app connection.
	Status AppStatus `json:"status"`
	// The Stripe account ID associated with the connected Stripe account.
	AccountID string `json:"account_id"`
	// Indicates whether the app is connected to a live Stripe account.
	Livemode bool `json:"livemode"`
	// The masked Stripe API key that only exposes the first and last few characters.
	MaskedAPIKey string `json:"masked_api_key"`
}

type AppStripeCheckoutSessionCustomTextParams struct {
	// Text displayed after the payment confirmation button.
	AfterSubmit *AppStripeCheckoutSessionCustomTextParamsAfterSubmit `json:"after_submit,omitempty"`
	// Text displayed alongside shipping address collection.
	ShippingAddress *AppStripeCheckoutSessionCustomTextParamsShippingAddress `json:"shipping_address,omitempty"`
	// Text displayed alongside the payment confirmation button.
	Submit *AppStripeCheckoutSessionCustomTextParamsSubmit `json:"submit,omitempty"`
	// Text replacing the default terms of service agreement text.
	TermsOfServiceAcceptance *AppStripeCheckoutSessionCustomTextParamsTermsOfServiceAcceptance `json:"terms_of_service_acceptance,omitempty"`
}

type AppStripeCheckoutSessionCustomTextParamsAfterSubmit struct {
	// The custom message text (max 1200 characters).
	Message *string `json:"message,omitempty"`
}

type AppStripeCheckoutSessionCustomTextParamsShippingAddress struct {
	// The custom message text (max 1200 characters).
	Message *string `json:"message,omitempty"`
}

type AppStripeCheckoutSessionCustomTextParamsSubmit struct {
	// The custom message text (max 1200 characters).
	Message *string `json:"message,omitempty"`
}

type AppStripeCheckoutSessionCustomTextParamsTermsOfServiceAcceptance struct {
	// The custom message text (max 1200 characters).
	Message *string `json:"message,omitempty"`
}

type AppStripeCheckoutSessionMode string

type AppStripeCheckoutSessionUiMode string

type AppStripeCreateCheckoutSessionBillingAddressCollection string

type AppStripeCreateCheckoutSessionConsentCollection struct {
	// Controls the visibility of payment method reuse agreement.
	PaymentMethodReuseAgreement *AppStripeCreateCheckoutSessionConsentCollectionPaymentMethodReuseAgreement `json:"payment_method_reuse_agreement,omitempty"`
	// Enables collection of promotional communication consent.
	//
	// Only available to US merchants. When set to "auto", Checkout determines whether
	// to show the option based on the customer's locale.
	Promotions *AppStripeCreateCheckoutSessionConsentCollectionPromotions `json:"promotions,omitempty"`
	// Requires customers to accept terms of service before payment.
	//
	// Requires a valid terms of service URL in your Stripe Dashboard settings.
	TermsOfService *AppStripeCreateCheckoutSessionConsentCollectionTermsOfService `json:"terms_of_service,omitempty"`
}

type AppStripeCreateCheckoutSessionConsentCollectionPaymentMethodReuseAgreement struct {
	// Position and visibility of the payment method reuse agreement.
	Position *AppStripeCreateCheckoutSessionConsentCollectionPaymentMethodReuseAgreementPosition `json:"position,omitempty"`
}

type AppStripeCreateCheckoutSessionConsentCollectionPaymentMethodReuseAgreementPosition string

type AppStripeCreateCheckoutSessionConsentCollectionPromotions string

type AppStripeCreateCheckoutSessionConsentCollectionTermsOfService string

type AppStripeCreateCheckoutSessionCustomerUpdate struct {
	// Whether to save the billing address to customer.address.
	//
	// Defaults to "never".
	Address *AppStripeCreateCheckoutSessionCustomerUpdateBehavior `json:"address,omitempty"`
	// Whether to save the customer name to customer.name.
	//
	// Defaults to "never".
	Name *AppStripeCreateCheckoutSessionCustomerUpdateBehavior `json:"name,omitempty"`
	// Whether to save shipping information to customer.shipping.
	//
	// Defaults to "never".
	Shipping *AppStripeCreateCheckoutSessionCustomerUpdateBehavior `json:"shipping,omitempty"`
}

type AppStripeCreateCheckoutSessionCustomerUpdateBehavior string

type AppStripeCreateCheckoutSessionRedirectOnCompletion string

type AppStripeCreateCheckoutSessionRequestOptions struct {
	// Whether to collect the customer's billing address.
	//
	// Defaults to auto, which only collects the address when necessary for tax
	// calculation.
	BillingAddressCollection *AppStripeCreateCheckoutSessionBillingAddressCollection `json:"billing_address_collection,omitempty"`
	// URL to redirect customers who cancel the checkout session.
	//
	// Not allowed when ui_mode is "embedded".
	CancelURL *string `json:"cancel_url,omitempty"`
	// Unique reference string for reconciling sessions with internal systems.
	//
	// Can be a customer ID, cart ID, or any other identifier.
	ClientReferenceID *string `json:"client_reference_id,omitempty"`
	// Controls which customer fields can be updated by the checkout session.
	CustomerUpdate *AppStripeCreateCheckoutSessionCustomerUpdate `json:"customer_update,omitempty"`
	// Configuration for collecting customer consent during checkout.
	ConsentCollection *AppStripeCreateCheckoutSessionConsentCollection `json:"consent_collection,omitempty"`
	// Three-letter ISO 4217 currency code in uppercase.
	//
	// Required for payment mode sessions. Optional for setup mode sessions.
	Currency *string `json:"currency,omitempty"`
	// Custom text to display during checkout at various stages.
	CustomText *AppStripeCheckoutSessionCustomTextParams `json:"custom_text,omitempty"`
	// Unix timestamp when the checkout session expires.
	//
	// Can be 30 minutes to 24 hours from creation. Defaults to 24 hours.
	ExpiresAt *int64 `json:"expires_at,omitempty"`
	// IETF language tag for the checkout UI locale.
	//
	// If blank or "auto", uses the browser's locale. Example: "en", "fr", "de".
	Locale *string `json:"locale,omitempty"`
	// Set of key-value pairs to attach to the checkout session.
	//
	// Useful for storing additional structured information.
	Metadata *map[string]string `json:"metadata,omitempty"`
	// Return URL for embedded checkout sessions after payment authentication.
	//
	// Required if ui_mode is "embedded" and redirect-based payment methods are
	// enabled.
	ReturnURL *string `json:"return_url,omitempty"`
	// Success URL to redirect customers after completing payment or setup.
	//
	// Not allowed when ui_mode is "embedded". See:
	// https://docs.stripe.com/payments/checkout/custom-success-page
	SuccessURL *string `json:"success_url,omitempty"`
	// The UI mode for the checkout session.
	//
	// "hosted" displays a Stripe-hosted page. "embedded" integrates directly into your
	// app. Defaults to "hosted".
	UiMode *AppStripeCheckoutSessionUiMode `json:"ui_mode,omitempty"`
	// List of payment method types to enable (e.g., "card", "us_bank_account").
	//
	// If not specified, Stripe enables all relevant payment methods.
	PaymentMethodTypes *[]string `json:"payment_method_types,omitempty"`
	// Redirect behavior for embedded checkout sessions.
	//
	// Controls when to redirect users after completion. See:
	// https://docs.stripe.com/payments/checkout/custom-success-page?payment-ui=embedded-form
	RedirectOnCompletion *AppStripeCreateCheckoutSessionRedirectOnCompletion `json:"redirect_on_completion,omitempty"`
	// Configuration for collecting tax IDs during checkout.
	TaxIDCollection *AppStripeCreateCheckoutSessionTaxIDCollection `json:"tax_id_collection,omitempty"`
}

type AppStripeCreateCheckoutSessionResult struct {
	// The customer ID in the billing system.
	CustomerID string `json:"customer_id"`
	// The Stripe customer ID.
	StripeCustomerID string `json:"stripe_customer_id"`
	// The Stripe checkout session ID.
	SessionID string `json:"session_id"`
	// The setup intent ID created for collecting the payment method.
	SetupIntentID string `json:"setup_intent_id"`
	// Client secret for initializing Stripe.js on the client side.
	//
	// Required for embedded checkout sessions. See:
	// https://docs.stripe.com/payments/checkout/custom-success-page
	ClientSecret *string `json:"client_secret,omitempty"`
	// The client reference ID provided in the request.
	//
	// Useful for reconciling the session with your internal systems.
	ClientReferenceID *string `json:"client_reference_id,omitempty"`
	// Customer's email address if provided to Stripe.
	CustomerEmail *string `json:"customer_email,omitempty"`
	// Currency code for the checkout session.
	Currency *string `json:"currency,omitempty"`
	// Timestamp when the checkout session was created.
	CreatedAt time.Time `json:"created_at"`
	// Timestamp when the checkout session will expire.
	ExpiresAt *time.Time `json:"expires_at,omitempty"`
	// Metadata attached to the checkout session.
	Metadata map[string]string `json:"metadata,omitempty"`
	// The status of the checkout session.
	//
	// See:
	// https://docs.stripe.com/api/checkout/sessions/object#checkout_session_object-status
	Status *string `json:"status,omitempty"`
	// URL to redirect customers to the checkout page (for hosted mode).
	URL *string `json:"url,omitempty"`
	// Mode of the checkout session.
	//
	// Currently only "setup" mode is supported for collecting payment methods.
	Mode AppStripeCheckoutSessionMode `json:"mode"`
	// The cancel URL where customers are redirected if they cancel.
	CancelURL *string `json:"cancel_url,omitempty"`
	// The success URL where customers are redirected after completion.
	SuccessURL *string `json:"success_url,omitempty"`
	// The return URL for embedded sessions after authentication.
	ReturnURL *string `json:"return_url,omitempty"`
}

type AppStripeCreateCheckoutSessionTaxIDCollection struct {
	// Enable tax ID collection during checkout.
	//
	// Defaults to false.
	Enabled *bool `json:"enabled,omitempty"`
	// Whether tax ID collection is required.
	//
	// Defaults to "never".
	Required *AppStripeCreateCheckoutSessionTaxIDCollectionRequired `json:"required,omitempty"`
}

type AppStripeCreateCheckoutSessionTaxIDCollectionRequired string

type AppStripeCreateCustomerPortalSessionOptions struct {
	// The ID of an existing
	// [Stripe configuration](https://docs.stripe.com/api/customer_portal/configurations)
	// to use for this session, describing its functionality and features. If not
	// specified, the session uses the default configuration.
	ConfigurationID *string `json:"configuration_id,omitempty"`
	// The IETF
	// [language tag](https://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-locale)
	// of the locale customer portal is displayed in. If blank or `auto`, the
	// customer's preferred_locales or browser's locale is used.
	Locale *string `json:"locale,omitempty"`
	// The
	// [URL to redirect](https://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-return_url)
	// the customer to after they have completed their requested actions.
	ReturnURL *string `json:"return_url,omitempty"`
}

type AppStripeCreateCustomerPortalSessionResult struct {
	// The ID of the customer portal session.
	//
	// See:
	// https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-id
	ID string `json:"id"`
	// The ID of the stripe customer.
	StripeCustomerID string `json:"stripe_customer_id"`
	// Configuration used to customize the customer portal.
	//
	// See:
	// https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-configuration
	ConfigurationID string `json:"configuration_id"`
	// Livemode.
	//
	// See:
	// https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-livemode
	Livemode bool `json:"livemode"`
	// Created at.
	//
	// See:
	// https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-created
	CreatedAt time.Time `json:"created_at"`
	// Return URL.
	//
	// See:
	// https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-return_url
	ReturnURL string `json:"return_url"`
	// The IETF language tag of the locale customer portal is displayed in.
	//
	// See:
	// https://docs.stripe.com/api/customer_portal/sessions/object#portal_session_object-locale
	Locale string `json:"locale"`
	// The URL to redirect the customer to after they have completed their requested
	// actions.
	URL string `json:"url"`
}

type AppType string

type AppsService struct {
	// contains filtered or unexported fields
}

type BillingCurrencyCode string

type BillingService struct {
	// contains filtered or unexported fields
}

type BillingSubscription struct {
	ID     string            `json:"id"`
	Labels map[string]string `json:"labels,omitempty"`
	// An ISO-8601 timestamp representation of entity creation date.
	CreatedAt time.Time `json:"created_at"`
	// An ISO-8601 timestamp representation of entity last update date.
	UpdatedAt time.Time `json:"updated_at"`
	// An ISO-8601 timestamp representation of entity deletion date.
	DeletedAt *time.Time `json:"deleted_at,omitempty"`
	// Display name of the subscription. Defaults to the plan name when the
	// subscription is created from a plan.
	Name string `json:"name"`
	// Optional description of the subscription.
	Description *string `json:"description,omitempty"`
	// An ISO-8601 timestamp representation of when the subscription became (or will
	// become) active.
	ActiveFrom time.Time `json:"active_from"`
	// An ISO-8601 timestamp representation of when the subscription stops being
	// active. Open-ended when not set.
	ActiveTo *time.Time `json:"active_to,omitempty"`
	// The customer ID of the subscription.
	CustomerID string `json:"customer_id"`
	// The plan ID of the subscription. Set if subscription is created from a plan.
	PlanID *string `json:"plan_id,omitempty"`
	// The plan the subscription was created from, if any. Includes the plan key and
	// version so clients can resolve the exact plan revision.
	Plan *SubscriptionPlanReference `json:"plan,omitempty"`
	// The fiat currency in which the subscription is invoiced.
	InvoiceCurrency string `json:"invoice_currency"`
	// Controls whether custom-currency cost bases are resolved dynamically or pinned
	// when their currency pair is introduced to the subscription.
	CostBasisMode SubscriptionCostBasisMode `json:"cost_basis_mode"`
	// Cost bases pinned to custom-currency pairs for this subscription.
	CostBasisPins []SubscriptionCostBasisPin `json:"cost_basis_pins"`
	// The billing cadence of the subscription in ISO-8601 duration format. Defines how
	// often the customer is billed. Examples: `P1M` (monthly), `P3M` (quarterly),
	// `P1Y` (annually).
	BillingCadence string `json:"billing_cadence"`
	// The pro-rating configuration of the subscription.
	ProRatingConfig *SubscriptionProRatingConfig `json:"pro_rating_config,omitempty"`
	// A billing anchor is the fixed point in time that determines the subscription's
	// recurring billing cycle. It affects when charges occur and how prorations are
	// calculated. Common anchors:
	//
	// - Calendar month (1st of each month): `2025-01-01T00:00:00Z`
	// - Subscription anniversary (day customer signed up)
	// - Custom date (customer-specified day)
	BillingAnchor time.Time `json:"billing_anchor"`
	// The status of the subscription.
	Status SubscriptionStatus `json:"status"`
	// Settlement mode for billing.
	//
	// Values:
	//
	// - `credit_then_invoice`: Credits are applied first, then any remainder is
	// invoiced.
	// - `credit_only`: Usage is settled exclusively against credits.
	SettlementMode *SettlementMode `json:"settlement_mode,omitempty"`
	// The current aligned billing period. Present only when the subscription is active
	// and aligned.
	CurrentPeriod *ClosedPeriod `json:"current_period,omitempty"`
	// The phases of the subscription in chronological order. A phase groups the rate
	// cards that are in effect for a segment of the subscription's lifetime.
	Phases []SubscriptionPhase `json:"phases"`
}

type BillingSubscriptionFilter struct {
	ID         *StringExactFilter
	CustomerID *StringExactFilter
	Status     *StringExactFilter
	PlanID     *StringExactFilter
	PlanKey    *StringExactFilter
}

type BillingSubscriptionListParams struct {
	Page   *PageParams
	Sort   *Sort
	Filter *BillingSubscriptionFilter
}

type BooleanFilter struct {
	Eq *bool
}

type Charge struct {
	Type string `json:"type"`
	// contains filtered or unexported fields
}

type ChargeCostBasis struct {
	Type string `json:"type"`
	// contains filtered or unexported fields
}

type ChargeCostBasisDynamic struct {
	// Discriminator selecting the cost basis mode.
	Type ChargeCostBasisType `json:"type"`
	// The fiat currency the charge amount is converted into for invoicing.
	FiatCurrency string `json:"fiat_currency"`
}

type ChargeCostBasisManual struct {
	// Discriminator selecting the cost basis mode.
	Type ChargeCostBasisType `json:"type"`
	// The fiat currency the charge amount is converted into for invoicing.
	FiatCurrency *string `json:"fiat_currency,omitempty"`
	// Fiat amount per one unit of the custom currency.
	Rate Numeric `json:"rate"`
}

type ChargeCostBasisPinned struct {
	// Discriminator selecting the cost basis mode.
	Type ChargeCostBasisType `json:"type"`
	// The fiat currency the charge amount is converted into for invoicing.
	FiatCurrency string `json:"fiat_currency"`
	// ID of the custom currency's cost basis resource to pin.
	CostBasisID string `json:"cost_basis_id"`
}

type ChargeCostBasisType string

type ChargeFlatFee struct {
	ID string `json:"id"`
	// Display name of the resource.
	//
	// Between 1 and 256 characters.
	Name string `json:"name"`
	// Optional description of the resource.
	//
	// Maximum 1024 characters.
	Description *string           `json:"description,omitempty"`
	Labels      map[string]string `json:"labels,omitempty"`
	// An ISO-8601 timestamp representation of entity creation date.
	CreatedAt time.Time `json:"created_at"`
	// An ISO-8601 timestamp representation of entity last update date.
	UpdatedAt time.Time `json:"updated_at"`
	// An ISO-8601 timestamp representation of entity deletion date.
	DeletedAt *time.Time `json:"deleted_at,omitempty"`
	// The type of the charge.
	Type ChargeType `json:"type"`
	// The customer owning the charge.
	//
	// By default, only the `id` of the customer is returned. For more details use the
	// `customer` expand.
	Customer CustomerOrReference `json:"customer"`
	// Indicates whether the charge lifecycle is controlled by the system or manually
	// overridden by the API user.
	LifecycleController LifecycleController `json:"lifecycle_controller"`
	// The subscription that originated the charge, when the charge was created from a
	// subscription item.
	//
	// By default, only the `id`, `phase.id`, `phase.item.id` of the subscription is
	// returned. For more details use the `subscription` expand.
	Subscription *SubscriptionOrReference `json:"subscription,omitempty"`
	// The currency of the charge.
	Currency BillingCurrencyCode `json:"currency"`
	// The resolved fiat conversion rate of a custom-currency charge. Resolution
	// depends on costbasis type: dynamic is resolved when charge becomes active, all
	// other types resolved on creation.
	ResolvedCostBasis *ChargeResolvedCostBasis `json:"resolved_cost_basis,omitempty"`
	// The lifecycle status of the charge.
	Status ChargeStatus `json:"status"`
	// Validation issues found while processing the charge.
	//
	// Present only when there are one or more validation findings. An empty list is
	// omitted.
	ValidationIssues []ValidationIssue `json:"validation_issues,omitempty"`
	// The timestamp when the charge is intended to be invoiced.
	InvoiceAt time.Time `json:"invoice_at"`
	// The effective service period covered by the charge.
	ServicePeriod ClosedPeriod `json:"service_period"`
	// The full, unprorated service period of the charge.
	FullServicePeriod ClosedPeriod `json:"full_service_period"`
	// The billing period the charge belongs to.
	BillingPeriod ClosedPeriod `json:"billing_period"`
	// The earliest time when the charge should be advanced again by background
	// processing.
	AdvanceAfter *time.Time `json:"advance_after,omitempty"`
	// Unique reference ID of the charge.
	UniqueReferenceID *string `json:"unique_reference_id,omitempty"`
	// Settlement mode of the charge.
	SettlementMode SettlementMode `json:"settlement_mode"`
	// Tax configuration of the charge.
	TaxConfig *TaxConfig `json:"tax_config,omitempty"`
	// The realization runs of the charge, sorted by `created_at`.
	Realizations []ChargeRealization `json:"realizations"`
	// Payment term of the flat fee charge.
	PaymentTerm PricePaymentTerm `json:"payment_term"`
	// The discounts applied to the charge.
	Discounts *ChargeFlatFeeDiscounts `json:"discounts,omitempty"`
	// The feature associated with the charge, when applicable.
	Feature *FeatureOrReference `json:"feature,omitempty"`
	// The proration configuration of the charge.
	ProrationConfiguration RateCardProrationConfiguration `json:"proration_configuration"`
	// The amount after proration of the charge.
	AmountAfterProration CurrencyAmount `json:"amount_after_proration"`
	// The price of the charge.
	Price PriceFlat `json:"price"`
	// Current intent from the system lifecycle controller for a charge that has an
	// active manual override. The top-level charge fields remain the effective
	// customer-facing intent.
	SystemIntent *ChargeFlatFeeSystemIntent `json:"system_intent,omitempty"`
}

type ChargeFlatFeeDiscounts struct {
	// Percentage discount applied to the price (0–100).
	Percentage *float64 `json:"percentage,omitempty"`
}

type ChargeFlatFeeSystemIntent struct {
	// Display name of the resource.
	//
	// Between 1 and 256 characters.
	Name string `json:"name"`
	// Optional description of the resource.
	//
	// Maximum 1024 characters.
	Description *string           `json:"description,omitempty"`
	Labels      map[string]string `json:"labels,omitempty"`
	// The timestamp when the charge is intended to be invoiced.
	InvoiceAt time.Time `json:"invoice_at"`
	// The effective service period covered by the charge.
	ServicePeriod ClosedPeriod `json:"service_period"`
	// The full, unprorated service period of the charge.
	FullServicePeriod ClosedPeriod `json:"full_service_period"`
	// The billing period the charge belongs to.
	BillingPeriod ClosedPeriod `json:"billing_period"`
	// Payment term of the flat fee charge.
	PaymentTerm PricePaymentTerm `json:"payment_term"`
	// The discounts applied to the charge.
	Discounts *ChargeFlatFeeDiscounts `json:"discounts,omitempty"`
	// The proration configuration of the charge.
	ProrationConfiguration RateCardProrationConfiguration `json:"proration_configuration"`
	// The amount before proration of the system lifecycle controller flat fee intent.
	AmountBeforeProration CurrencyAmount `json:"amount_before_proration"`
	// The timestamp when the system lifecycle controller intent was deleted. The
	// effective charge can remain visible while a manual override is active.
	DeletedAt *time.Time `json:"deleted_at,omitempty"`
}

type ChargePagePaginatedResponse struct {
	Data []Charge      `json:"data"`
	Meta PaginatedMeta `json:"meta"`
}

type ChargeRealization struct {
	// The ID of the realization run. Not present on `outstanding` entries, which are
	// projections rather than persisted runs.
	ID *string `json:"id,omitempty"`
	// The ID of the invoice line this realization was booked to, when the realization
	// has been invoiced.
	LineID *string `json:"line_id,omitempty"`
	// The reference of the invoice related to the realization.
	Invoice *ChargeRealizationInvoiceOrReference `json:"invoice,omitempty"`
	// The type of the realization run.
	Type ChargeRealizationType `json:"type"`
	// The service period covered by this realization run.
	ServicePeriod ClosedPeriod `json:"service_period"`
	// The metered usage quantity this realization run accounts for. Only present on
	// usage-based charges; flat fees are not metered, so their realizations carry no
	// usage.
	//
	// Booked entries report a signed delta: a negative value states a downward usage
	// correction (or a voided run that snapshotted behind its live neighbors) instead
	// of masking it as zero.
	//
	// On an `outstanding` entry this is `0` unless the `real_time_usage` expand is
	// applied, in which case it is the not-yet-booked remainder of the live metering
	// read (never negative).
	Usage *Numeric `json:"usage,omitempty"`
	// The payment state of the realization, when the charge requires a fiat
	// transaction to settle.
	Payment *ChargeRealizationPayment `json:"payment,omitempty"`
	// Financial totals for the realization run, including credit allocations.
	//
	// Requires the `realization.totals` expand.
	Totals *Totals `json:"totals,omitempty"`
	// The detailed (rated) lines produced by the realization run.
	//
	// Requires the `realization.detailed_lines` expand.
	DetailedLines []ChargeRealizationDetailedLine `json:"detailed_lines,omitempty"`
}

type ChargeRealizationAmountDiscount struct {
	// The amount of the discount applied to the charge.
	Amount Numeric `json:"amount"`
	// The reason for the discount applied to the charge.
	Reason string `json:"reason"`
	// Optional human-readable description of the discount.
	Description *string `json:"description,omitempty"`
	// The discount amount applied to the charge, rounded to the nearest cent (or
	// currency equivalent) and adjusted to compensate for rounding errors across
	// multiple discounted detail lines.
	RoundingAmount *Numeric `json:"rounding_amount,omitempty"`
	// Unique reference ID of the discount applied to the charge.
	ChildUniqueReferenceID string `json:"child_unique_reference_id"`
}

type ChargeRealizationDetailedLine struct {
	Type string `json:"type"`
	// contains filtered or unexported fields
}

type ChargeRealizationDetailedLineCategory string

type ChargeRealizationDetailedLineCreditApplied struct {
	// The monetary amount credited.
	Amount Numeric `json:"amount"`
	// Human-readable description of the credit allocation.
	Description *string `json:"description,omitempty"`
	// The ID of the credit realization (allocation) this credit was applied from.
	CreditRealizationID string `json:"credit_realization_id"`
}

type ChargeRealizationDetailedLineFlatFee struct {
	ID string `json:"id"`
	// An ISO-8601 timestamp representation of entity creation date.
	CreatedAt time.Time `json:"created_at"`
	// An ISO-8601 timestamp representation of entity last update date.
	UpdatedAt time.Time `json:"updated_at"`
	// An ISO-8601 timestamp representation of entity deletion date.
	DeletedAt *time.Time `json:"deleted_at,omitempty"`
	// The type of the charge the realization belongs to.
	Type ChargeType `json:"type"`
	// The service period covered by this detailed line.
	ServicePeriod ClosedPeriod `json:"service_period"`
	// Aggregated financial totals for the detailed line.
	Totals Totals `json:"totals"`
	// The cost category of this detailed line.
	Category ChargeRealizationDetailedLineCategory `json:"category"`
	// Credits applied to this detailed line.
	CreditsApplied []ChargeRealizationDetailedLineCreditApplied `json:"credits_applied,omitempty"`
	// The unit price of the detailed line.
	UnitPrice Numeric `json:"unit_price"`
	// The amount discounts applied to the detailed line.
	AmountDiscounts []ChargeRealizationAmountDiscount `json:"amount_discounts"`
}

type ChargeRealizationDetailedLineUsageBased struct {
	ID string `json:"id"`
	// An ISO-8601 timestamp representation of entity creation date.
	CreatedAt time.Time `json:"created_at"`
	// An ISO-8601 timestamp representation of entity last update date.
	UpdatedAt time.Time `json:"updated_at"`
	// An ISO-8601 timestamp representation of entity deletion date.
	DeletedAt *time.Time `json:"deleted_at,omitempty"`
	// The type of the charge the realization belongs to.
	Type ChargeType `json:"type"`
	// The service period covered by this detailed line.
	ServicePeriod ClosedPeriod `json:"service_period"`
	// Aggregated financial totals for the detailed line.
	Totals Totals `json:"totals"`
	// The cost category of this detailed line.
	Category ChargeRealizationDetailedLineCategory `json:"category"`
	// Credits applied to this detailed line.
	CreditsApplied []ChargeRealizationDetailedLineCreditApplied `json:"credits_applied,omitempty"`
	// The unit price of the detailed line.
	UnitPrice Numeric `json:"unit_price"`
	// The amount discounts applied to the detailed line.
	AmountDiscounts []ChargeRealizationAmountDiscount `json:"amount_discounts"`
	// The quantity of the detailed line.
	Quantity Numeric `json:"quantity"`
	// The ID of a prior realization run this detailed line corrects. Only set if the
	// detailed line's totals are negative.
	CorrectsRunID *string `json:"corrects_run_id,omitempty"`
}

type ChargeRealizationInvoice struct {
	ID string `json:"id"`
	// Optional description of the resource.
	//
	// Maximum 1024 characters.
	Description *string           `json:"description,omitempty"`
	Labels      map[string]string `json:"labels,omitempty"`
	// An ISO-8601 timestamp representation of entity creation date.
	CreatedAt time.Time `json:"created_at"`
	// An ISO-8601 timestamp representation of entity last update date.
	UpdatedAt time.Time `json:"updated_at"`
	// An ISO-8601 timestamp representation of entity deletion date.
	DeletedAt *time.Time `json:"deleted_at,omitempty"`
	// Human-readable invoice number generated by the invoicing app.
	Number string `json:"number"`
	// Three-letter ISO 4217 currency code for the invoice.
	Currency string `json:"currency"`
	// Snapshot of the supplier's contact information at the time the invoice was
	// issued.
	Supplier Supplier `json:"supplier"`
	// Aggregated financial totals for the invoice.
	Totals Totals `json:"totals"`
	// The service period covered by this invoice.
	//
	// For flat fee the service period can be empty which means `from` will be equals
	// to `to`. In other cases those fields will be filled with the actual service
	// period.
	ServicePeriod ClosedPeriod `json:"service_period"`
	// Validation issues found during invoice processing.
	//
	// Present only when there are one or more validation findings. An empty list is
	// omitted.
	ValidationIssues []ValidationIssue `json:"validation_issues,omitempty"`
	// External identifiers assigned to this invoice by third-party systems.
	ExternalReferences *InvoiceExternalReferences `json:"external_references,omitempty"`
	// Discriminator field identifying this as a standard invoice.
	Type InvoiceType `json:"type"`
	// Current lifecycle status of the invoice.
	Status InvoiceStandardStatus `json:"status"`
	// Detailed status information including available actions and workflow state.
	StatusDetails InvoiceStatusDetails `json:"status_details"`
	// Timestamp when the invoice was issued to the customer.
	IssuedAt *time.Time `json:"issued_at,omitempty"`
	// Timestamp until which the invoice remains in draft state.
	//
	// The invoice advances automatically once this time is reached.
	DraftUntil *time.Time `json:"draft_until,omitempty"`
	// Timestamp when usage quantities were last snapshotted for this invoice.
	QuantitySnapshottedAt *time.Time `json:"quantity_snapshotted_at,omitempty"`
	// Timestamp when collection was initiated for this invoice.
	CollectionAt *time.Time `json:"collection_at,omitempty"`
	// Timestamp when payment is due.
	DueAt *time.Time `json:"due_at,omitempty"`
	// Timestamp when the invoice was sent to the customer.
	SentToCustomerAt *time.Time `json:"sent_to_customer_at,omitempty"`
	// Workflow configuration snapshot captured at invoice creation time.
	Workflow InvoiceWorkflowSettings `json:"workflow"`
}

type ChargeRealizationInvoiceOrReference struct {
	// contains filtered or unexported fields
}

type ChargeRealizationInvoiceReference struct {
	ID string `json:"id"`
}

type ChargeRealizationPayment struct {
	// The settlement status of the payment.
	Status ChargeRealizationPaymentStatus `json:"status"`
}

type ChargeRealizationPaymentStatus string

type ChargeRealizationType string

type ChargeReference struct {
	// Unique identifier for the charge.
	ID string `json:"id"`
}

type ChargeResolvedCostBasis struct {
	// The fiat currency the charge amount is converted into for invoicing.
	FiatCurrency string `json:"fiat_currency"`
	// Fiat amount per one unit of the custom currency.
	Rate Numeric `json:"rate"`
	// ID of the custom currency's cost basis resource the rate was taken from. Absent
	// for manual cost bases.
	CostBasisID *string `json:"cost_basis_id,omitempty"`
	// When the rate was resolved.
	ResolvedAt time.Time `json:"resolved_at"`
}

type ChargeStatus string

type ChargeTotals struct {
	// The amount of the charge already booked to the internal accounting system.
	Booked Totals `json:"booked"`
	// The realtime amount of the charge, i.e. the whole usage rated at the charge's
	// price for its full service period, ignoring what has already been booked to a
	// realization. This differs from the `usage` of a realization with type
	// `outstanding`, which only covers the quantity not yet booked.
	//
	// Requires the `real_time_usage` expand.
	Realtime *Totals `json:"realtime,omitempty"`
}

type ChargeType string

type ChargeUsageBased struct {
	ID string `json:"id"`
	// Display name of the resource.
	//
	// Between 1 and 256 characters.
	Name string `json:"name"`
	// Optional description of the resource.
	//
	// Maximum 1024 characters.
	Description *string           `json:"description,omitempty"`
	Labels      map[string]string `json:"labels,omitempty"`
	// An ISO-8601 timestamp representation of entity creation date.
	CreatedAt time.Time `json:"created_at"`
	// An ISO-8601 timestamp representation of entity last update date.
	UpdatedAt time.Time `json:"updated_at"`
	// An ISO-8601 timestamp representation of entity deletion date.
	DeletedAt *time.Time `json:"deleted_at,omitempty"`
	// The type of the charge.
	Type ChargeType `json:"type"`
	// The customer owning the charge.
	//
	// By default, only the `id` of the customer is returned. For more details use the
	// `customer` expand.
	Customer CustomerOrReference `json:"customer"`
	// Indicates whether the charge lifecycle is controlled by the system or manually
	// overridden by the API user.
	LifecycleController LifecycleController `json:"lifecycle_controller"`
	// The subscription that originated the charge, when the charge was created from a
	// subscription item.
	//
	// By default, only the `id`, `phase.id`, `phase.item.id` of the subscription is
	// returned. For more details use the `subscription` expand.
	Subscription *SubscriptionOrReference `json:"subscription,omitempty"`
	// The currency of the charge.
	Currency BillingCurrencyCode `json:"currency"`
	// The resolved fiat conversion rate of a custom-currency charge. Resolution
	// depends on costbasis type: dynamic is resolved when charge becomes active, all
	// other types resolved on creation.
	ResolvedCostBasis *ChargeResolvedCostBasis `json:"resolved_cost_basis,omitempty"`
	// The lifecycle status of the charge.
	Status ChargeStatus `json:"status"`
	// Validation issues found while processing the charge.
	//
	// Present only when there are one or more validation findings. An empty list is
	// omitted.
	ValidationIssues []ValidationIssue `json:"validation_issues,omitempty"`
	// The timestamp when the charge is intended to be invoiced.
	InvoiceAt time.Time `json:"invoice_at"`
	// The effective service period covered by the charge.
	ServicePeriod ClosedPeriod `json:"service_period"`
	// The full, unprorated service period of the charge.
	FullServicePeriod ClosedPeriod `json:"full_service_period"`
	// The billing period the charge belongs to.
	BillingPeriod ClosedPeriod `json:"billing_period"`
	// The earliest time when the charge should be advanced again by background
	// processing.
	AdvanceAfter *time.Time `json:"advance_after,omitempty"`
	// Unique reference ID of the charge.
	UniqueReferenceID *string `json:"unique_reference_id,omitempty"`
	// Settlement mode of the charge.
	SettlementMode SettlementMode `json:"settlement_mode"`
	// Tax configuration of the charge.
	TaxConfig *TaxConfig `json:"tax_config,omitempty"`
	// The realization runs of the charge, sorted by `created_at`.
	Realizations []ChargeRealization `json:"realizations"`
	// Discounts applied to the usage-based charge.
	Discounts *RateCardDiscounts `json:"discounts,omitempty"`
	// The feature associated with the charge.
	Feature FeatureOrReference `json:"feature"`
	// Aggregated booked and realtime totals for the charge.
	Totals ChargeTotals `json:"totals"`
	// The metered usage quantity of the charge for its full service period.
	//
	// Requires the `real_time_usage` expand, since it is computed live from the
	// metering store rather than stored on the charge.
	Usage *Numeric `json:"usage,omitempty"`
	// The price of the charge.
	//
	// `free` prices are rejected on create: a usage-based charge always carries a
	// concrete price.
	Price PriceUsageBased `json:"price"`
	// Spend commitments for the charge.
	Commitments *SpendCommitments `json:"commitments,omitempty"`
	// Unit conversion configuration for the charge.
	//
	// Synthesized on read for charges created from v1 dynamic or package prices:
	// dynamic prices map to a unit price with a multiply unit config, and package
	// prices map to a unit price with a divide unit config.
	//
	// Accepted on create only when the UnitConfig feature is enabled on the
	// deployment; otherwise rejected.
	UnitConfig *UnitConfig `json:"unit_config,omitempty"`
	// Current intent from the system lifecycle controller for a charge that has an
	// active manual override. The top-level charge fields remain the effective
	// customer-facing intent.
	SystemIntent *ChargeUsageBasedSystemIntent `json:"system_intent,omitempty"`
}

type ChargeUsageBasedSystemIntent struct {
	// Display name of the resource.
	//
	// Between 1 and 256 characters.
	Name string `json:"name"`
	// Optional description of the resource.
	//
	// Maximum 1024 characters.
	Description *string           `json:"description,omitempty"`
	Labels      map[string]string `json:"labels,omitempty"`
	// The timestamp when the charge is intended to be invoiced.
	InvoiceAt time.Time `json:"invoice_at"`
	// The effective service period covered by the charge.
	ServicePeriod ClosedPeriod `json:"service_period"`
	// The full, unprorated service period of the charge.
	FullServicePeriod ClosedPeriod `json:"full_service_period"`
	// The billing period the charge belongs to.
	BillingPeriod ClosedPeriod `json:"billing_period"`
	// Discounts applied to the usage-based charge.
	Discounts *RateCardDiscounts `json:"discounts,omitempty"`
	// The price of the charge.
	//
	// `free` prices are rejected on create: a usage-based charge always carries a
	// concrete price.
	Price PriceUsageBased `json:"price"`
	// Spend commitments for the charge.
	Commitments *SpendCommitments `json:"commitments,omitempty"`
	// Unit conversion configuration for the charge.
	//
	// Synthesized on read for charges created from v1 dynamic or package prices:
	// dynamic prices map to a unit price with a multiply unit config, and package
	// prices map to a unit price with a divide unit config.
	//
	// Accepted on create only when the UnitConfig feature is enabled on the
	// deployment; otherwise rejected.
	UnitConfig *UnitConfig `json:"unit_config,omitempty"`
	// The timestamp when the system lifecycle controller intent was deleted. The
	// effective charge can remain visible while a manual override is active.
	DeletedAt *time.Time `json:"deleted_at,omitempty"`
}

type ChargesExpand string

type ChargesService struct {
	// contains filtered or unexported fields
}

type Client struct {
	Events            *EventsService
	Meters            *MetersService
	Customers         *CustomersService
	Entitlements      *EntitlementsService
	Grants            *GrantsService
	Subscriptions     *SubscriptionsService
	Apps              *AppsService
	Billing           *BillingService
	Invoices          *InvoicesService
	Charges           *ChargesService
	Tax               *TaxService
	Currencies        *CurrenciesService
	Features          *FeaturesService
	LLMCost           *LLMCostService
	Plans             *PlansService
	Addons            *AddonsService
	PlanAddons        *PlanAddonsService
	Defaults          *DefaultsService
	EntitlementAccess *EntitlementAccessService
	Notifications     *NotificationsService
	// contains filtered or unexported fields
}

type ClosedPeriod struct {
	// The start of the period.
	//
	// The period is inclusive at the start.
	From time.Time `json:"from"`
	// The end of the period.
	//
	// The period is exclusive at the end.
	To time.Time `json:"to"`
}

type CollectionAlignment string

type CollectionMethod string

type CostBasis struct {
	ID string `json:"id"`
	// The fiat currency code for the cost basis.
	FiatCode string `json:"fiat_code"`
	// The cost rate for the currency.
	Rate Numeric `json:"rate"`
	// An ISO-8601 timestamp representation of the date from which the cost basis is
	// effective. If not provided, it will be effective immediately and will be set to
	// `now` by the system.
	EffectiveFrom *time.Time `json:"effective_from,omitempty"`
	// An ISO-8601 timestamp representation of the date until which the cost basis is
	// effective. If provided, it must be later than `effective_from`. If not provided,
	// it remains effective until superseded.
	EffectiveTo *time.Time `json:"effective_to,omitempty"`
	// An ISO-8601 timestamp representation of entity creation date.
	CreatedAt time.Time `json:"created_at"`
}

type CostBasisFilter struct {
	// Filter cost bases by fiat currency code.
	FiatCode *string
}

type CostBasisListParams struct {
	Filter *CostBasisFilter
	Page   *PageParams
}

type CostBasisPagePaginatedResponse struct {
	Data []CostBasis   `json:"data"`
	Meta PaginatedMeta `json:"meta"`
}

type CreateAddonRequest struct {
	// Display name of the resource.
	//
	// Between 1 and 256 characters.
	Name string `json:"name"`
	// Optional description of the resource.
	//
	// Maximum 1024 characters.
	Description *string            `json:"description,omitempty"`
	Labels      *map[string]string `json:"labels,omitempty"`
	// A key is a semi-unique string that is used to identify the add-on. It is used to
	// reference the latest `active` version of the add-on and is unique with the
	// version number.
	Key string `json:"key"`
	// The InstanceType of the add-ons. Can be "single" or "multiple".
	InstanceType AddonInstanceType `json:"instance_type"`
	// The currency code of the add-on.
	Currency BillingCurrencyCode `json:"currency"`
	// The rate cards of the add-on.
	RateCards []RateCardInput `json:"rate_cards"`
}

type CreateBillingProfileRequest struct {
	// Display name of the resource.
	//
	// Between 1 and 256 characters.
	Name string `json:"name"`
	// Optional description of the resource.
	//
	// Maximum 1024 characters.
	Description *string            `json:"description,omitempty"`
	Labels      *map[string]string `json:"labels,omitempty"`
	// The name and contact information for the supplier this billing profile
	// represents
	Supplier Party `json:"supplier"`
	// The billing workflow settings for this profile
	Workflow Workflow `json:"workflow"`
	// The applications used by this billing profile.
	Apps ProfileAppReferences `json:"apps"`
	// Whether this is the default profile.
	Default bool `json:"default"`
}

type CreateChargeFlatFeeRequest struct {
	// Display name of the resource.
	//
	// Between 1 and 256 characters.
	Name string `json:"name"`
	// Optional description of the resource.
	//
	// Maximum 1024 characters.
	Description *string            `json:"description,omitempty"`
	Labels      *map[string]string `json:"labels,omitempty"`
	// The type of the charge.
	Type ChargeType `json:"type"`
	// The currency of the charge.
	Currency BillingCurrencyCode `json:"currency"`
	// Defines how a custom-currency charge is converted into its fiat invoice
	// currency; the resolved rate is exposed through `resolved_cost_basis`. Required
	// when `currency` is custom and the charge settles as `credit_then_invoice`; must
	// be omitted otherwise.
	CostBasis *ChargeCostBasis `json:"cost_basis,omitempty"`
	// The timestamp when the charge is intended to be invoiced.
	InvoiceAt time.Time `json:"invoice_at"`
	// The effective service period covered by the charge.
	ServicePeriod ClosedPeriod `json:"service_period"`
	// Unique reference ID of the charge.
	UniqueReferenceID *string `json:"unique_reference_id,omitempty"`
	// Settlement mode of the charge.
	SettlementMode SettlementMode `json:"settlement_mode"`
	// Tax configuration of the charge.
	TaxConfig *TaxConfig `json:"tax_config,omitempty"`
	// Payment term of the flat fee charge.
	PaymentTerm PricePaymentTerm `json:"payment_term"`
	// The discounts applied to the charge.
	Discounts *ChargeFlatFeeDiscounts `json:"discounts,omitempty"`
	// The proration configuration of the charge.
	ProrationConfiguration RateCardProrationConfiguration `json:"proration_configuration"`
	// The amount before proration of the charge.
	AmountBeforeProration CurrencyAmount `json:"amount_before_proration"`
	// A reference to the feature associated with the charge, when applicable.
	Feature *FeatureReference `json:"feature,omitempty"`
	// The full, unprorated service period of the charge.
	FullServicePeriod *ClosedPeriod `json:"full_service_period,omitempty"`
	// The billing period the charge belongs to.
	BillingPeriod *ClosedPeriod `json:"billing_period,omitempty"`
}

type CreateChargeRequest struct {
	Type string `json:"type"`
	// contains filtered or unexported fields
}

type CreateChargeUsageBasedRequest struct {
	// Display name of the resource.
	//
	// Between 1 and 256 characters.
	Name string `json:"name"`
	// Optional description of the resource.
	//
	// Maximum 1024 characters.
	Description *string            `json:"description,omitempty"`
	Labels      *map[string]string `json:"labels,omitempty"`
	// The type of the charge.
	Type ChargeType `json:"type"`
	// The currency of the charge.
	Currency BillingCurrencyCode `json:"currency"`
	// Defines how a custom-currency charge is converted into its fiat invoice
	// currency; the resolved rate is exposed through `resolved_cost_basis`. Required
	// when `currency` is custom and the charge settles as `credit_then_invoice`; must
	// be omitted otherwise.
	CostBasis *ChargeCostBasis `json:"cost_basis,omitempty"`
	// The timestamp when the charge is intended to be invoiced.
	InvoiceAt time.Time `json:"invoice_at"`
	// The effective service period covered by the charge.
	ServicePeriod ClosedPeriod `json:"service_period"`
	// Unique reference ID of the charge.
	UniqueReferenceID *string `json:"unique_reference_id,omitempty"`
	// Settlement mode of the charge.
	SettlementMode SettlementMode `json:"settlement_mode"`
	// Tax configuration of the charge.
	TaxConfig *TaxConfig `json:"tax_config,omitempty"`
	// Discounts applied to the usage-based charge.
	Discounts *RateCardDiscounts `json:"discounts,omitempty"`
	// The price of the charge.
	//
	// `free` prices are rejected on create: a usage-based charge always carries a
	// concrete price.
	Price PriceUsageBased `json:"price"`
	// Spend commitments for the charge.
	Commitments *SpendCommitments `json:"commitments,omitempty"`
	// Unit conversion configuration for the charge.
	//
	// Synthesized on read for charges created from v1 dynamic or package prices:
	// dynamic prices map to a unit price with a multiply unit config, and package
	// prices map to a unit price with a divide unit config.
	//
	// Accepted on create only when the UnitConfig feature is enabled on the
	// deployment; otherwise rejected.
	UnitConfig *UnitConfig `json:"unit_config,omitempty"`
	// A reference to the feature associated with the charge.
	Feature FeatureReference `json:"feature"`
	// The full, unprorated service period of the charge.
	FullServicePeriod *ClosedPeriod `json:"full_service_period,omitempty"`
	// The billing period the charge belongs to.
	BillingPeriod *ClosedPeriod `json:"billing_period,omitempty"`
}

type CreateCostBasisRequest struct {
	// The fiat currency code for the cost basis.
	FiatCode string `json:"fiat_code"`
	// The cost rate for the currency.
	Rate Numeric `json:"rate"`
	// An ISO-8601 timestamp representation of the date from which the cost basis is
	// effective. If not provided, it will be effective immediately and will be set to
	// `now` by the system.
	EffectiveFrom *time.Time `json:"effective_from,omitempty"`
	// An ISO-8601 timestamp representation of the date until which the cost basis is
	// effective. If provided, it must be later than `effective_from`. If not provided,
	// it remains effective until superseded.
	EffectiveTo *time.Time `json:"effective_to,omitempty"`
}

type CreateCreditAdjustmentRequest struct {
	// Display name of the resource.
	//
	// Between 1 and 256 characters.
	Name string `json:"name"`
	// Optional description of the resource.
	//
	// Maximum 1024 characters.
	Description *string            `json:"description,omitempty"`
	Labels      *map[string]string `json:"labels,omitempty"`
	// The currency of the granted credits.
	Currency BillingCurrencyCode `json:"currency"`
	// Granted credit amount.
	Amount Numeric `json:"amount"`
}

type CreateCreditGrantFilters struct {
	// Limit the credit grant to specific features. If no features are specified, the
	// credit grant can be used for any feature.
	Features *[]string `json:"features,omitempty"`
	// Limit credits to charges from these plans. Entries are alternatives; when
	// features are also specified, both dimensions must match. Omission or an empty
	// list leaves plans unrestricted.
	Plans *[]CreateCreditGrantPlanFilter `json:"plans,omitempty"`
}

type CreateCreditGrantPlanFilter struct {
	// The plan key in the customer's namespace.
	Key string `json:"key"`
	// Omission matches all versions, including future versions.
	Version *CreateVersionFilter `json:"version,omitempty"`
}

type CreateCreditGrantPurchase struct {
	// Fiat currency the purchase is settled in.
	//
	// Must equal the grant `currency` for fiat grants and `cost_basis.fiat_currency`
	// for custom-currency grants.
	Currency string `json:"currency"`
	// Fiat cost basis per credit unit of a fiat-currency grant.
	//
	// If `per_unit_cost_basis` is 0.50 and credit amount is
	// $100.00, the total
	// charge is $50.00. The value must be greater than 0. If the
	// cost basis is 0, use `funding_method=none` instead.
	//
	// Only applies to fiat grants and cannot be combined with `cost_basis`. Defaults
	// to 1.0 when neither is provided.
	PerUnitCostBasis *Numeric `json:"per_unit_cost_basis,omitempty"`
	// Defines how custom-currency credits are priced in the purchase `currency`; the
	// resolved rate is exposed through `resolved_cost_basis`.
	//
	// Fiat grants accept only a `manual` cost basis without `fiat_currency`, where
	// `rate` is the fiat cost per credit unit. Custom-currency grants require a cost
	// basis of any type with `fiat_currency` set and equal to the purchase `currency`.
	// A `dynamic` cost basis is resolved at the grant's effective time, so the
	// currency cost basis must be effective by then. Cannot be combined with
	// `per_unit_cost_basis`.
	CostBasis *ChargeCostBasis `json:"cost_basis,omitempty"`
	// Controls when credits become available for consumption.
	//
	// Defaults to `on_creation`.
	AvailabilityPolicy *CreditAvailabilityPolicy `json:"availability_policy,omitempty"`
}

type CreateCreditGrantRequest struct {
	// Display name of the resource.
	//
	// Between 1 and 256 characters.
	Name string `json:"name"`
	// Optional description of the resource.
	//
	// Maximum 1024 characters.
	Description *string            `json:"description,omitempty"`
	Labels      *map[string]string `json:"labels,omitempty"`
	// Funding method of the grant.
	FundingMethod CreditFundingMethod `json:"funding_method"`
	// The fiat or custom currency of the granted credits.
	//
	// Funded custom-currency grants must define `purchase.cost_basis` to settle in a
	// fiat currency.
	Currency BillingCurrencyCode `json:"currency"`
	// Granted credit amount.
	Amount Numeric `json:"amount"`
	// Present when a funding workflow applies (funding_method is not `none`).
	Purchase *CreateCreditGrantPurchase `json:"purchase,omitempty"`
	// Tax configuration for the grant.
	//
	// For `invoice` and `external` funding methods, tax configuration should be
	// provided to ensure correct revenue recognition. When not provided, the default
	// credit grant tax code is applied, if that's not set the global default taxcode
	// is used.
	TaxConfig *TaxCodeConfig            `json:"tax_config,omitempty"`
	Filters   *CreateCreditGrantFilters `json:"filters,omitempty"`
	// Draw-down priority of the grant. Lower values have higher priority.
	Priority *int16 `json:"priority,omitempty"`
	// The timestamp when the credit grant becomes effective.
	//
	// Defaults to the current date and time.
	EffectiveAt *time.Time `json:"effective_at,omitempty"`
	// The duration after which the credit grant expires.
	//
	// Defaults to never expiring.
	ExpiresAfter *string `json:"expires_after,omitempty"`
	// Idempotency key for the credit grant creation request.
	//
	// Unique per customer: reusing the same key for the same customer returns an HTTP
	// 409 Conflict instead of creating a duplicate grant, which makes create requests
	// safe to retry. The same key may be reused across different customers.
	Key *string `json:"key,omitempty"`
}

type CreateCurrencyCustomRequest struct {
	// The name of the currency. It should be a human-readable string that represents
	// the name of the currency, such as "US Dollar" or "Euro".
	Name string `json:"name"`
	// The symbol of the currency. It should be a string that represents the symbol of
	// the currency, such as "$" for US Dollar or "€" for Euro.
	Symbol *string `json:"symbol,omitempty"`
	// The precision of the currency. It should be a number that represents the number
	// of decimal places used for the currency, such as 2 for US Dollar or Euro.
	Precision uint32 `json:"precision"`
	// The decimal mark for the currency. It should be a string that represents the
	// decimal mark of the currency, such as "." for US Dollar or "," for Euro.
	DecimalMark string `json:"decimal_mark"`
	// The thousand separator for the currency. It should be a string that represents
	// the thousand separator of the currency, such as "," for US Dollar or "." for
	// Euro.
	ThousandSeparator string `json:"thousand_separator"`
	Code              string `json:"code"`
}

type CreateCustomerRequest struct {
	// Display name of the resource.
	//
	// Between 1 and 256 characters.
	Name string `json:"name"`
	// Optional description of the resource.
	//
	// Maximum 1024 characters.
	Description *string            `json:"description,omitempty"`
	Labels      *map[string]string `json:"labels,omitempty"`
	Key         string             `json:"key"`
	// Mapping to attribute metered usage to the customer by the event subject.
	UsageAttribution *CustomerUsageAttribution `json:"usage_attribution,omitempty"`
	// The primary email address of the customer.
	PrimaryEmail *string `json:"primary_email,omitempty"`
	// Currency of the customer. Used for billing, tax and invoicing.
	Currency *string `json:"currency,omitempty"`
	// The billing address of the customer. Used for tax and invoicing.
	BillingAddress *Address `json:"billing_address,omitempty"`
}

type CreateEntitlementBooleanRequest struct {
	// The type of the entitlement.
	Type EntitlementType `json:"type"`
	// The feature the customer is entitled to use.
	Feature FeatureReference   `json:"feature"`
	Labels  *map[string]string `json:"labels,omitempty"`
	// The usage period of the entitlement. The anchor defaults to the entitlement
	// creation time.
	UsagePeriod *RecurringPeriodInput `json:"usage_period,omitempty"`
}

type CreateEntitlementMeteredRequest struct {
	// The type of the entitlement.
	Type EntitlementType `json:"type"`
	// The feature the customer is entitled to use.
	Feature FeatureReference   `json:"feature"`
	Labels  *map[string]string `json:"labels,omitempty"`
	// If true, the customer keeps access to the feature after the balance is
	// exhausted.
	IsSoftLimit *bool `json:"is_soft_limit,omitempty"`
	// Usage granted automatically after each reset. Cannot be combined with `grants`.
	Issue *EntitlementIssueAfterReset `json:"issue,omitempty"`
	// The amount granted automatically after each reset.
	IssueAfterReset *Numeric `json:"issue_after_reset,omitempty"`
	// The priority of the grant created after each reset.
	IssueAfterResetPriority *uint8 `json:"issue_after_reset_priority,omitempty"`
	// If true, the overage is preserved at reset. If false, the usage is reset to 0.
	PreserveOverageAtReset *bool `json:"preserve_overage_at_reset,omitempty"`
	// The usage period of the entitlement. The balance resets at the start of every
	// period. The anchor defaults to the entitlement creation time.
	UsagePeriod RecurringPeriodInput `json:"usage_period"`
	// The time from which usage is measured. Defaults to the entitlement creation
	// time.
	MeasureUsageFrom *EntitlementMeasureUsageFrom `json:"measure_usage_from,omitempty"`
	// Grants created together with the entitlement. Cannot be combined with `issue`.
	Grants *[]EntitlementGrantCreateRequest `json:"grants,omitempty"`
}

type CreateEntitlementRequest struct {
	Type string `json:"type"`
	// contains filtered or unexported fields
}

type CreateEntitlementStaticRequest struct {
	// The type of the entitlement.
	Type EntitlementType `json:"type"`
	// The feature the customer is entitled to use.
	Feature FeatureReference   `json:"feature"`
	Labels  *map[string]string `json:"labels,omitempty"`
	// The entitlement configuration as a JSON value. Returned when checking
	// entitlement access.
	Config any `json:"config"`
	// The usage period of the entitlement. The anchor defaults to the entitlement
	// creation time.
	UsagePeriod *RecurringPeriodInput `json:"usage_period,omitempty"`
}

type CreateFeatureRequest struct {
	// Display name of the resource.
	//
	// Between 1 and 256 characters.
	Name string `json:"name"`
	// Optional description of the resource.
	//
	// Maximum 1024 characters.
	Description *string            `json:"description,omitempty"`
	Labels      *map[string]string `json:"labels,omitempty"`
	Key         string             `json:"key"`
	// The meter that the feature is associated with and based on which usage is
	// calculated. If not specified, the feature is static.
	Meter *FeatureMeterReferenceInput `json:"meter,omitempty"`
	// Optional per-unit cost configuration. Use "manual" for a fixed per-unit cost, or
	// "llm" to look up cost from the LLM cost database based on meter group-by
	// properties.
	UnitCost *FeatureUnitCost `json:"unit_cost,omitempty"`
}