exoapi_stripe v0.1.4

View Source ExOAPI.Stripe.Schemas.Quote (exoapi_stripe v0.1.4)

description: A Quote is a way to model prices that you'd like to provide to a customer. Once accepted, it will automatically create an invoice, subscription or subscription schedule.

:application_fee_percent :: :number

A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. Only applicable if there are line items with recurring prices on the quote.

:computed :: ExOAPI.Stripe.Schemas.QuotesResourceComputed

:livemode :: :boolean

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

:collection_method :: :string

Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or on finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions. Defaults to charge_automatically.

::data :: ExOAPI.Stripe.Schemas.Item

:has_more :: :boolean

True if this list has another page of items after this one that can be fetched.

:object :: :string

String representing the object's type. Objects of the same type share the same value. Always has the value list.

:url :: :string

The URL where this list can be accessed.

:metadata :: :map

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

:subscription_data :: ExOAPI.Stripe.Schemas.QuotesResourceSubscriptionData

:description :: :string

A description that will be displayed on the quote PDF.

:footer :: :string

A footer that will be displayed on the quote PDF.

:header :: :string

A header that will be displayed on the quote PDF.

:subscription_schedule :: ExOAPI.Stripe.Schemas.SubscriptionSchedule | :string

The subscription schedule that was created or updated from this quote.

:on_behalf_of :: ExOAPI.Stripe.Schemas.Account | :string

The account on behalf of which to charge. See the Connect documentation for details.

:customer :: ExOAPI.Stripe.Schemas.DeletedCustomer | ExOAPI.Stripe.Schemas.Customer | :string

The customer which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.

:invoice :: ExOAPI.Stripe.Schemas.DeletedInvoice | ExOAPI.Stripe.Schemas.Invoice | :string

The invoice that was created from this quote.

:object :: :string

String representing the object's type. Objects of the same type share the same value.

:invoice_settings :: ExOAPI.Stripe.Schemas.InvoiceSettingQuoteSetting

All invoices will be billed using the specified settings.

:total_details :: ExOAPI.Stripe.Schemas.QuotesResourceTotalDetails

:expires_at :: :integer

The date on which the quote will be canceled if in open or draft status. Measured in seconds since the Unix epoch.

:status_transitions :: ExOAPI.Stripe.Schemas.QuotesResourceStatusTransitions

:test_clock :: ExOAPI.Stripe.Schemas.TestHelpers_testClock | :string

ID of the test clock this quote belongs to.

:automatic_tax :: ExOAPI.Stripe.Schemas.QuotesResourceAutomaticTax

:currency :: :string

Three-letter ISO currency code, in lowercase. Must be a supported currency.

:created :: :integer

Time at which the object was created. Measured in seconds since the Unix epoch.

::discounts :: ExOAPI.Stripe.Schemas.Discount | :string

:amount_subtotal :: :integer

Total before any discounts or taxes are applied.

:amount_total :: :integer

Total after discounts and taxes are applied.

:subscription :: ExOAPI.Stripe.Schemas.Subscription | :string

The subscription that was created or updated from this quote.

:status :: :string

The status of the quote.

:from_quote :: ExOAPI.Stripe.Schemas.QuotesResourceFromQuote

Details of the quote that was cloned. See the cloning documentation for more details.

:number :: :string

A unique number that identifies this particular quote. This number is assigned once the quote is finalized.

:application_fee_amount :: :integer

The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Only applicable if there are no line items with recurring prices on the quote.

:transfer_data :: ExOAPI.Stripe.Schemas.QuotesResourceTransferData

The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the invoices.

:id :: :string

Unique identifier for the object.

::default_tax_rates :: ExOAPI.Stripe.Schemas.TaxRate | :string

Link to this section Summary

Types

params()
t()

Functions

changeset(struct \\ %__MODULE__{}, params)

Link to this section Types

Link to this type

params()

View Source 
@type params() :: map()
Link to this type

t()

View Source 
@type t() :: %ExOAPI.Stripe.Schemas.Quote{
  amount_subtotal: integer() | nil,
  amount_total: integer() | nil,
  application_fee_amount: integer() | nil,
  application_fee_percent: float() | nil,
  automatic_tax: ExOAPI.Stripe.Schemas.QuotesResourceAutomaticTax.t() | nil,
  collection_method: (:send_invoice | :charge_automatically) | nil,
  computed: ExOAPI.Stripe.Schemas.QuotesResourceComputed.t() | nil,
  created: integer() | nil,
  currency: String.t() | nil,
  customer: ExOAPI.EctoTypes.AnyOf.t() | nil,
  default_tax_rates: [ExOAPI.EctoTypes.AnyOf.t()] | nil,
  description: String.t() | nil,
  discounts: [ExOAPI.EctoTypes.AnyOf.t()] | nil,
  expires_at: integer() | nil,
  footer: String.t() | nil,
  from_quote: ExOAPI.EctoTypes.AnyOf.t() | nil,
  header: String.t() | nil,
  id: String.t() | nil,
  invoice: ExOAPI.EctoTypes.AnyOf.t() | nil,
  invoice_settings: ExOAPI.EctoTypes.AnyOf.t() | nil,
  line_items: map() | nil,
  livemode: boolean() | nil,
  metadata: map() | nil,
  number: String.t() | nil,
  object: :quote | nil,
  on_behalf_of: ExOAPI.EctoTypes.AnyOf.t() | nil,
  status: (:open | :draft | :canceled | :accepted) | nil,
  status_transitions:
    ExOAPI.Stripe.Schemas.QuotesResourceStatusTransitions.t() | nil,
  subscription: ExOAPI.EctoTypes.AnyOf.t() | nil,
  subscription_data:
    ExOAPI.Stripe.Schemas.QuotesResourceSubscriptionData.t() | nil,
  subscription_schedule: ExOAPI.EctoTypes.AnyOf.t() | nil,
  test_clock: ExOAPI.EctoTypes.AnyOf.t() | nil,
  total_details: ExOAPI.Stripe.Schemas.QuotesResourceTotalDetails.t() | nil,
  transfer_data: ExOAPI.EctoTypes.AnyOf.t() | nil
}

Link to this section Functions

Link to this function

changeset(struct \\ %__MODULE__{}, params)

View Source 
@spec changeset(t(), params()) :: Ecto.Changeset.t()