stream.clojure.stripe.api.products — stream.clojure/stripe-clojure 1.0.0-beta.1

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

create clj

(create {:keys [body]})

Create a product

HTTP Method: POST Endpoint: /v1/products

Example Usage: (create {})

delete-id clj

(delete-id {:keys [product-id]})

Delete a product

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

Path Parameters:

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

Example Usage: (delete-id {:product-id example-product-id})

delete-product-features-id clj

(delete-product-features-id {:keys [product-id feature-id]})

Remove a feature from a product

HTTP Method: DELETE Endpoint: /v1/products/{product-id}/features/{feature-id}

Path Parameters:

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

Example Usage: (delete-product-features-id {:product-id example-product-id :feature-id example-feature-id})

list-all clj

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

List all products

HTTP Method: GET Endpoint: /v1/products

Query Parameters:

• active (Boolean): Only return products that are active or inactive (e.g., pass false to list all inactive products).
• created (Unknown): Only return products that were created during the given date interval.
• 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.
• ids (Array): Only return products with the given IDs. Cannot be used with starting_after or ending_before.
• limit (Integer): A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
• shippable (Boolean): Only return products that can be shipped (i.e., physical, not digital products).
• 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.
• url (String): Only return products with the given url.

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

list-all-product-features clj

(list-all-product-features {:keys [product-id query-params]})

List all features attached to a product

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

Path Parameters:

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

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-product-features {:product-id example-product-id :query-params {:limit 10}})

list-all-search clj

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

Search products

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

Query Parameters:

• 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.
• page (String): A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
• query (String): The search query string. See search query language and the list of supported query fields for products. (required)

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

post-product-features clj

(post-product-features {:keys [product-id body]})

Attach a feature to a product

HTTP Method: POST Endpoint: /v1/products/{product-id}/features

Path Parameters:

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

Example Usage: (post-product-features {:product-id example-product-id})

retrieve-id clj

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

Retrieve a product

HTTP Method: GET Endpoint: /v1/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-id {:product-id example-product-id :query-params {:limit 10}})

retrieve-product-features-id clj

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

Retrieve a product_feature

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

Path Parameters:

• product-id (String): The ID of the product.
• feature-id (String): The ID of the product_feature.

Query Parameters:

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

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

update-id clj

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

Update a product

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

Path Parameters:

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

Example Usage: (update-id {:product-id example-product-id})