Liking cljdoc? Tell your friends :D

stream.clojure.stripe.api.entitlements

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

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

Create a feature

HTTP Method: POST Endpoint: /v1/entitlements/features

Example Usage: (create-features {})

Create a feature

HTTP Method: POST
Endpoint: /v1/entitlements/features

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

list-all-activeclj

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

List all active entitlements

HTTP Method: GET Endpoint: /v1/entitlements/active_entitlements

Query Parameters:

  • customer (String): The ID of the customer. (required)
  • 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-active {:query-params {:limit 10}})

List all active entitlements

HTTP Method: GET
Endpoint: /v1/entitlements/active_entitlements

Query Parameters:
  - customer (String): The ID of the customer. (required)
  - 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-active {:query-params {:limit 10}})
sourceraw docstring

list-all-featuresclj

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

List all features

HTTP Method: GET Endpoint: /v1/entitlements/features

Query Parameters:

  • archived (Boolean): If set, filter results to only include features with the given archive status.
  • 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.
  • lookup-key (String): If set, filter results to only include features with the given lookup_key.
  • 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-features {:query-params {:limit 10}})

List all features

HTTP Method: GET
Endpoint: /v1/entitlements/features

Query Parameters:
  - archived (Boolean): If set, filter results to only include features with the given archive status.
  - 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.
  - lookup-key (String): If set, filter results to only include features with the given lookup_key.
  - 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-features {:query-params {:limit 10}})
sourceraw docstring

post-features-idclj

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

Updates a feature

HTTP Method: POST Endpoint: /v1/entitlements/features/{feature-id}

Path Parameters:

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

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

Updates a feature

HTTP Method: POST
Endpoint: /v1/entitlements/features/{feature-id}

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

Example Usage:
  (post-features-id {:feature-id example-feature-id})
sourceraw docstring

retrieve-active-idclj

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

Retrieve an active entitlement

HTTP Method: GET Endpoint: /v1/entitlements/active_entitlements/{active-entitlement-id}

Path Parameters:

  • active-entitlement-id (String): The ID of the entitlement.

Query Parameters:

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

Example Usage: (retrieve-active-id {:active-entitlement-id example-active-entitlement-id :query-params {:limit 10}})

Retrieve an active entitlement

HTTP Method: GET
Endpoint: /v1/entitlements/active_entitlements/{active-entitlement-id}

Path Parameters:
  - active-entitlement-id (String): The ID of the entitlement.

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

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

retrieve-features-idclj

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

Retrieve a feature

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

Path Parameters:

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

Query Parameters:

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

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

Retrieve a feature

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

Path Parameters:
  - feature-id (String): The ID of the feature.

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

Example Usage:
  (retrieve-features-id {:feature-id example-feature-id :query-params {:limit 10}})
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