View Source ExOAPI.Stripe.SDK.ShippingRates (exoapi_stripe v0.1.1)

Link to this section Summary

Functions

description: <p>Returns a list of your shipping rates.</p>

description: <p>Returns the shipping rate object with the given ID.</p>

description: <p>Creates a new shipping rate object.</p>

description: <p>Updates an existing shipping rate object.</p>

Link to this section Types

Link to this type

get_shipping_rates_opts()

View Source
@type get_shipping_rates_opts() ::
  {:starting_after, String.t()}
  | {:limit, String.t()}
  | {:expand, String.t()}
  | {:ending_before, String.t()}
  | {:currency, String.t()}
  | {:created, String.t()}
  | {:active, String.t()}
Link to this type

get_shipping_rates_shipping_rate_token_opts()

View Source
@type get_shipping_rates_shipping_rate_token_opts() :: {:expand, String.t()}

Link to this section Functions

Link to this function

get_shipping_rates(client, opts \\ [])

View Source
@spec get_shipping_rates(client :: ExOAPI.Client.t(), [get_shipping_rates_opts()]) ::
  {:ok, any()} | {:error, any()}

description: <p>Returns a list of your shipping rates.</p>

Link to this function

get_shipping_rates_shipping_rate_token(client, shipping_rate_token, opts \\ [])

View Source
@spec get_shipping_rates_shipping_rate_token(
  client :: ExOAPI.Client.t(),
  shipping_rate_token :: String.t(),
  [get_shipping_rates_shipping_rate_token_opts()]
) :: {:ok, any()} | {:error, any()}

description: <p>Returns the shipping rate object with the given ID.</p>

Link to this function

post_shipping_rates(client, body)

View Source
@spec post_shipping_rates(client :: ExOAPI.Client.t(), body :: map()) ::
  {:ok, any()} | {:error, any()}

description: <p>Creates a new shipping rate object.</p>

Link to this function

post_shipping_rates_shipping_rate_token(client, body, shipping_rate_token)

View Source
@spec post_shipping_rates_shipping_rate_token(
  client :: ExOAPI.Client.t(),
  body :: map(),
  shipping_rate_token :: String.t()
) :: {:ok, any()} | {:error, any()}

description: <p>Updates an existing shipping rate object.</p>