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

Link to this section Summary

Functions

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

description: <p>Retrieves the price with the given ID.</p>

description: <p>Search for prices you’ve previously created using Stripe’s <a href="/docs/search#search-query-language">Search Query Language</a>. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.</p>

description: <p>Creates a new price for an existing product. The price can be recurring or one-time.</p>

description: <p>Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.</p>

Link to this section Types

@type get_prices_opts() ::
  {:type, String.t()}
  | {:starting_after, String.t()}
  | {:recurring, String.t()}
  | {:product, String.t()}
  | {:lookup_keys, 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_prices_price_opts()

View Source
@type get_prices_price_opts() :: {:expand, String.t()}
Link to this type

get_prices_search_opts()

View Source
@type get_prices_search_opts() ::
  {:page, String.t()} | {:limit, String.t()} | {:expand, String.t()}

Link to this section Functions

Link to this function

get_prices(client, opts \\ [])

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

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

Link to this function

get_prices_price(client, price, opts \\ [])

View Source
@spec get_prices_price(
  client :: ExOAPI.Client.t(),
  price :: String.t(),
  [get_prices_price_opts()]
) :: {:ok, any()} | {:error, any()}

description: <p>Retrieves the price with the given ID.</p>

Link to this function

get_prices_search(client, query, opts \\ [])

View Source
@spec get_prices_search(
  client :: ExOAPI.Client.t(),
  query :: String.t(),
  [get_prices_search_opts()]
) :: {:ok, any()} | {:error, any()}

description: <p>Search for prices you’ve previously created using Stripe’s <a href="/docs/search#search-query-language">Search Query Language</a>. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.</p>

Link to this function

post_prices(client, body)

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

description: <p>Creates a new price for an existing product. The price can be recurring or one-time.</p>

Link to this function

post_prices_price(client, body, price)

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

description: <p>Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.</p>