Liking cljdoc? Tell your friends :D

stream.clojure.stripe.api.climate

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-ordersclj

(create-orders {:keys [body]})

Create an order

HTTP Method: POST Endpoint: /v1/climate/orders

Example Usage: (create-orders {})

Create an order

HTTP Method: POST
Endpoint: /v1/climate/orders

Example Usage:
  (create-orders {})
sourceraw docstring

list-all-ordersclj

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

List orders

HTTP Method: GET Endpoint: /v1/climate/orders

Query Parameters:

  • 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-orders {:query-params {:limit 10}})

List orders

HTTP Method: GET
Endpoint: /v1/climate/orders

Query Parameters:
  - 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-orders {:query-params {:limit 10}})
sourceraw docstring

list-all-productsclj

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

List products

HTTP Method: GET Endpoint: /v1/climate/products

Query Parameters:

  • 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-products {:query-params {:limit 10}})

List products

HTTP Method: GET
Endpoint: /v1/climate/products

Query Parameters:
  - 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-products {:query-params {:limit 10}})
sourceraw docstring

list-all-suppliersclj

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

List suppliers

HTTP Method: GET Endpoint: /v1/climate/suppliers

Query Parameters:

  • 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-suppliers {:query-params {:limit 10}})

List suppliers

HTTP Method: GET
Endpoint: /v1/climate/suppliers

Query Parameters:
  - 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-suppliers {:query-params {:limit 10}})
sourceraw docstring

post-orders-order-cancelclj

(post-orders-order-cancel {:keys [order-id body]})

Cancel an order

HTTP Method: POST Endpoint: /v1/climate/orders/{order-id}/cancel

Path Parameters:

  • order-id (String): Unique identifier of the order.

Example Usage: (post-orders-order-cancel {:order-id example-order-id})

Cancel an order

HTTP Method: POST
Endpoint: /v1/climate/orders/{order-id}/cancel

Path Parameters:
  - order-id (String): Unique identifier of the order.

Example Usage:
  (post-orders-order-cancel {:order-id example-order-id})
sourceraw docstring

retrieve-orders-orderclj

(retrieve-orders-order {:keys [order-id query-params]})

Retrieve an order

HTTP Method: GET Endpoint: /v1/climate/orders/{order-id}

Path Parameters:

  • order-id (String): Unique identifier of the order.

Query Parameters:

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

Example Usage: (retrieve-orders-order {:order-id example-order-id :query-params {:limit 10}})

Retrieve an order

HTTP Method: GET
Endpoint: /v1/climate/orders/{order-id}

Path Parameters:
  - order-id (String): Unique identifier of the order.

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

Example Usage:
  (retrieve-orders-order {:order-id example-order-id :query-params {:limit 10}})
sourceraw docstring

retrieve-products-productclj

(retrieve-products-product {:keys [product-id query-params]})

Retrieve a product

HTTP Method: GET Endpoint: /v1/climate/products/{product-id}

Path Parameters:

  • product-id (String): The product-id parameter. (required)

Query Parameters:

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

Example Usage: (retrieve-products-product {:product-id example-product-id :query-params {:limit 10}})

Retrieve a product

HTTP Method: GET
Endpoint: /v1/climate/products/{product-id}

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

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

Example Usage:
  (retrieve-products-product {:product-id example-product-id :query-params {:limit 10}})
sourceraw docstring

retrieve-suppliers-supplierclj

(retrieve-suppliers-supplier {:keys [supplier-id query-params]})

Retrieve a supplier

HTTP Method: GET Endpoint: /v1/climate/suppliers/{supplier-id}

Path Parameters:

  • supplier-id (String): The supplier-id parameter. (required)

Query Parameters:

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

Example Usage: (retrieve-suppliers-supplier {:supplier-id example-supplier-id :query-params {:limit 10}})

Retrieve a supplier

HTTP Method: GET
Endpoint: /v1/climate/suppliers/{supplier-id}

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

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

Example Usage:
  (retrieve-suppliers-supplier {:supplier-id example-supplier-id :query-params {:limit 10}})
sourceraw docstring

update-orders-orderclj

(update-orders-order {:keys [order-id body]})

Update an order

HTTP Method: POST Endpoint: /v1/climate/orders/{order-id}

Path Parameters:

  • order-id (String): Unique identifier of the order.

Example Usage: (update-orders-order {:order-id example-order-id})

Update an order

HTTP Method: POST
Endpoint: /v1/climate/orders/{order-id}

Path Parameters:
  - order-id (String): Unique identifier of the order.

Example Usage:
  (update-orders-order {:order-id example-order-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