Liking cljdoc? Tell your friends :D

stream.clojure.stripe.api.shipping-rates

Info: This ns is auto-generated from the Stripe OpenAPI spec.

Info: This ns is auto-generated from the Stripe OpenAPI spec.
raw docstring

create-shipping-ratesclj

(create-shipping-rates {:keys [body]})

Create a shipping rate

HTTP Method: POST Endpoint: /v1/shipping_rates

Example Usage: (create-shipping-rates {})

Create a shipping rate

HTTP Method: POST
Endpoint: /v1/shipping_rates

Example Usage:
  (create-shipping-rates {})
sourceraw docstring

list-all-shipping-ratesclj

(list-all-shipping-rates {:keys [query-params]})

List all shipping rates

HTTP Method: GET Endpoint: /v1/shipping_rates

Query Parameters:

  • active (Boolean): Only return shipping rates that are active or inactive.
  • created (Unknown): A filter on the list, based on the object created field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
  • currency (String): Only return shipping rates for the given currency.
  • ending-before (String): A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
  • expand (Array): Specifies which fields in the response should be expanded.
  • limit (Integer): A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
  • starting-after (String): A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Example Usage: (list-all-shipping-rates {:query-params {:limit 10}})

List all shipping rates

HTTP Method: GET
Endpoint: /v1/shipping_rates

Query Parameters:
  - active (Boolean): Only return shipping rates that are active or inactive.
  - created (Unknown): A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
  - currency (String): Only return shipping rates for the given currency.
  - ending-before (String): A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
  - expand (Array): Specifies which fields in the response should be expanded.
  - limit (Integer): A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
  - starting-after (String): A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Example Usage:
  (list-all-shipping-rates {:query-params {:limit 10}})
sourceraw docstring

retrieve-shipping-rates-shipping-rate-tokenclj

(retrieve-shipping-rates-shipping-rate-token {:keys [shipping-rate-id
                                                     query-params]})

Retrieve a shipping rate

HTTP Method: GET Endpoint: /v1/shipping_rates/{shipping-rate-id}

Path Parameters:

  • shipping-rate-id (String): The shipping-rate-id parameter. (required)

Query Parameters:

  • expand (Array): Specifies which fields in the response should be expanded.

Example Usage: (retrieve-shipping-rates-shipping-rate-token {:shipping-rate-id example-shipping-rate-id :query-params {:limit 10}})

Retrieve a shipping rate

HTTP Method: GET
Endpoint: /v1/shipping_rates/{shipping-rate-id}

Path Parameters:
  - shipping-rate-id (String): The shipping-rate-id parameter. (required)

Query Parameters:
  - expand (Array): Specifies which fields in the response should be expanded.

Example Usage:
  (retrieve-shipping-rates-shipping-rate-token {:shipping-rate-id example-shipping-rate-id :query-params {:limit 10}})
sourceraw docstring

update-shipping-rates-shipping-rate-tokenclj

(update-shipping-rates-shipping-rate-token {:keys [shipping-rate-id body]})

Update a shipping rate

HTTP Method: POST Endpoint: /v1/shipping_rates/{shipping-rate-id}

Path Parameters:

  • shipping-rate-id (String): The shipping-rate-id parameter. (required)

Example Usage: (update-shipping-rates-shipping-rate-token {:shipping-rate-id example-shipping-rate-id})

Update a shipping rate

HTTP Method: POST
Endpoint: /v1/shipping_rates/{shipping-rate-id}

Path Parameters:
  - shipping-rate-id (String): The shipping-rate-id parameter. (required)

Example Usage:
  (update-shipping-rates-shipping-rate-token {:shipping-rate-id example-shipping-rate-id})
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close