Stripe.Params.Billing.CreditBalanceSummaryRetrieveParams (tiger_stripe v0.3.0)

Parameters for credit balance summary retrieve.

Summary

Types

filter()

filter_applicability_scope()

filter_applicability_scope_prices()

t()

Types

filter()

@type filter() :: %{
  optional(:applicability_scope) => filter_applicability_scope() | nil,
  optional(:credit_grant) => String.t() | nil,
  optional(:type) => String.t() | nil,
  optional(String.t()) => term()
}

applicability_scope - The billing credit applicability scope for which to fetch credit balance summary.
credit_grant - The credit grant for which to fetch credit balance summary. Max length: 5000.
type - Specify the type of this filter. Possible values: applicability_scope, credit_grant.

filter_applicability_scope()

@type filter_applicability_scope() :: %{
  optional(:price_type) => String.t() | nil,
  optional(:prices) => [filter_applicability_scope_prices()] | nil,
  optional(String.t()) => term()
}

price_type - The price type that credit grants can apply to. We currently only support the metered price type. Cannot be used in combination with prices. Possible values: metered.
prices - A list of prices that the credit grant can apply to. We currently only support the metered prices. Cannot be used in combination with price_type.

filter_applicability_scope_prices()

@type filter_applicability_scope_prices() :: %{
  optional(:id) => String.t() | nil,
  optional(String.t()) => term()
}

id - The price ID this credit grant should apply to. Max length: 5000.

t()

@type t() :: %Stripe.Params.Billing.CreditBalanceSummaryRetrieveParams{
  customer: String.t() | nil,
  customer_account: String.t() | nil,
  expand: [String.t()] | nil,
  filter: filter()
}

customer - The customer whose credit balance summary you're retrieving. Max length: 5000.
customer_account - The account representing the customer whose credit balance summary you're retrieving. Max length: 5000.
expand - Specifies which fields in the response should be expanded.
filter - The filter criteria for the credit balance summary.