class Stripe::EntitlementsApi
- Stripe::EntitlementsApi
- Reference
- Object
Defined in:
stripe/api/entitlements_api.crConstant Summary
-
GET_ENTITLEMENTS_ACTIVE_ENTITLEMENTS_ID_MAX_LENGTH_FOR_ID =
5000 -
GET_ENTITLEMENTS_ACTIVE_ENTITLEMENTS_MAX_LENGTH_FOR_CUSTOMER =
5000 -
GET_ENTITLEMENTS_ACTIVE_ENTITLEMENTS_MAX_LENGTH_FOR_ENDING_BEFORE =
5000 -
GET_ENTITLEMENTS_ACTIVE_ENTITLEMENTS_MAX_LENGTH_FOR_STARTING_AFTER =
5000 -
GET_ENTITLEMENTS_FEATURES_ID_MAX_LENGTH_FOR_ID =
5000 -
GET_ENTITLEMENTS_FEATURES_MAX_LENGTH_FOR_ENDING_BEFORE =
5000 -
GET_ENTITLEMENTS_FEATURES_MAX_LENGTH_FOR_LOOKUP_KEY =
5000 -
GET_ENTITLEMENTS_FEATURES_MAX_LENGTH_FOR_STARTING_AFTER =
5000 -
POST_ENTITLEMENTS_FEATURES_ID_MAX_LENGTH_FOR_ID =
5000 -
POST_ENTITLEMENTS_FEATURES_ID_MAX_LENGTH_FOR_NAME =
80 -
POST_ENTITLEMENTS_FEATURES_MAX_LENGTH_FOR_LOOKUP_KEY =
80 -
POST_ENTITLEMENTS_FEATURES_MAX_LENGTH_FOR_NAME =
80
Constructors
Instance Method Summary
- #api_client : ApiClient
- #api_client=(api_client : ApiClient)
-
#build_api_request_for_get_entitlements_active_entitlements(*, customer : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_entitlements_active_entitlements_id(*, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_entitlements_features(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, archived : Bool | Nil = nil, lookup_key : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_entitlements_features_id(*, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_entitlements_features(*, lookup_key : String | Nil = nil, name : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Hash(String, String) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_entitlements_features_id(*, id : String | Nil = nil, active : Bool | Nil = nil, expand : Array(String) | Nil = nil, metadata : Stripe::PostEntitlementsFeaturesIdRequestMetadata | Nil = nil, name : String | Nil = nil) : Crest::Request
@return Crest::Request
- #client_side_validation?(*args, **options)
- #client_side_validation?(*args, **options, &)
- #debugging?(*args, **options)
- #debugging?(*args, **options, &)
-
#get_entitlements_active_entitlements(*, customer : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::EntitlementsResourceCustomerEntitlementList
Retrieve a list of active entitlements for a customer
@required @param customer [String?] The ID of the customer. -
#get_entitlements_active_entitlements(*, customer : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Retrieve a list of active entitlements for a customer</p> @required @param customer [String?] The ID of the customer.
-
#get_entitlements_active_entitlements_id(*, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::EntitlementsActiveEntitlement
Retrieve an active entitlement
@required @param id [String?] The ID of the entitlement. -
#get_entitlements_active_entitlements_id(*, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Retrieve an active entitlement</p> @required @param id [String?] The ID of the entitlement.
-
#get_entitlements_active_entitlements_id_with_http_info(*, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::EntitlementsActiveEntitlement, Int32, Hash(String, Array(String) | String))
<p>Retrieve an active entitlement</p> @required @param id [String?] The ID of the entitlement.
-
#get_entitlements_active_entitlements_with_http_info(*, customer : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::EntitlementsResourceCustomerEntitlementList, Int32, Hash(String, Array(String) | String))
<p>Retrieve a list of active entitlements for a customer</p> @required @param customer [String?] The ID of the customer.
-
#get_entitlements_features(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, archived : Bool | Nil = nil, lookup_key : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::EntitlementsResourceFeatureList
Retrieve a list of features
@optional @param ending_before [String?] A cursor for use in pagination. -
#get_entitlements_features(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, archived : Bool | Nil = nil, lookup_key : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Retrieve a list of features</p> @optional @param ending_before [String?] A cursor for use in pagination.
-
#get_entitlements_features_id(*, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::EntitlementsFeature
Retrieves a feature
@required @param id [String?] The ID of the feature. -
#get_entitlements_features_id(*, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Retrieves a feature</p> @required @param id [String?] The ID of the feature.
-
#get_entitlements_features_id_with_http_info(*, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::EntitlementsFeature, Int32, Hash(String, Array(String) | String))
<p>Retrieves a feature</p> @required @param id [String?] The ID of the feature.
-
#get_entitlements_features_with_http_info(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, archived : Bool | Nil = nil, lookup_key : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::EntitlementsResourceFeatureList, Int32, Hash(String, Array(String) | String))
<p>Retrieve a list of features</p> @optional @param ending_before [String?] A cursor for use in pagination.
-
#post_entitlements_features(*, lookup_key : String | Nil = nil, name : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Hash(String, String) | Nil = nil) : Stripe::EntitlementsFeature
Creates a feature
@required @param lookup_key [String?] A unique key you provide as your own system identifier. -
#post_entitlements_features(*, lookup_key : String | Nil = nil, name : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Hash(String, String) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Creates a feature</p> @required @param lookup_key [String?] A unique key you provide as your own system identifier.
-
#post_entitlements_features_id(*, id : String | Nil = nil, active : Bool | Nil = nil, expand : Array(String) | Nil = nil, metadata : Stripe::PostEntitlementsFeaturesIdRequestMetadata | Nil = nil, name : String | Nil = nil) : Stripe::EntitlementsFeature
Update a feature’s metadata or permanently deactivate it.
@required @param id [String?] @optional @param active [Bool?] Inactive features cannot be attached to new products and will not be returned from the features list endpoint. -
#post_entitlements_features_id(*, id : String | Nil = nil, active : Bool | Nil = nil, expand : Array(String) | Nil = nil, metadata : Stripe::PostEntitlementsFeaturesIdRequestMetadata | Nil = nil, name : String | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Update a feature’s metadata or permanently deactivate it.</p> @required @param id [String?] @optional @param active [Bool?] Inactive features cannot be attached to new products and will not be returned from the features list endpoint.
-
#post_entitlements_features_id_with_http_info(*, id : String | Nil = nil, active : Bool | Nil = nil, expand : Array(String) | Nil = nil, metadata : Stripe::PostEntitlementsFeaturesIdRequestMetadata | Nil = nil, name : String | Nil = nil) : Tuple(Stripe::EntitlementsFeature, Int32, Hash(String, Array(String) | String))
<p>Update a feature’s metadata or permanently deactivate it.</p> @required @param id [String?] @optional @param active [Bool?] Inactive features cannot be attached to new products and will not be returned from the features list endpoint.
-
#post_entitlements_features_with_http_info(*, lookup_key : String | Nil = nil, name : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Hash(String, String) | Nil = nil) : Tuple(Stripe::EntitlementsFeature, Int32, Hash(String, Array(String) | String))
<p>Creates a feature</p> @required @param lookup_key [String?] A unique key you provide as your own system identifier.
Constructor Detail
Instance Method Detail
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
Retrieve a list of active entitlements for a customer
@required @param customer [String?] The ID of the customer. @optional @param 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. @optional @param 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. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::EntitlementsResourceCustomerEntitlementList]<p>Retrieve a list of active entitlements for a customer</p>
@required @param customer [String?] The ID of the customer.
@optional @param 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.
@optional @param 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.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return nil
Retrieve an active entitlement
@required @param id [String?] The ID of the entitlement. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::EntitlementsActiveEntitlement]<p>Retrieve an active entitlement</p> @required @param id [String?] The ID of the entitlement. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil
<p>Retrieve an active entitlement</p> @required @param id [String?] The ID of the entitlement. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::EntitlementsActiveEntitlement, Integer, Hash)] Stripe::EntitlementsActiveEntitlement, response status code and response headers
<p>Retrieve a list of active entitlements for a customer</p>
@required @param customer [String?] The ID of the customer.
@optional @param 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.
@optional @param 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.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return [Tuple(Stripe::EntitlementsResourceCustomerEntitlementList, Integer, Hash)] Stripe::EntitlementsResourceCustomerEntitlementList, response status code and response headers
Retrieve a list of features
@optional @param 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. @optional @param 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. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param archived [Bool?] If set, filter results to only include features with the given archive status. @optional @param lookup_key [String?] If set, filter results to only include features with the given lookup_key. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::EntitlementsResourceFeatureList]<p>Retrieve a list of features</p>
@optional @param 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.
@optional @param 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.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param archived [Bool?] If set, filter results to only include features with the given archive status.
@optional @param lookup_key [String?] If set, filter results to only include features with the given lookup_key.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return nil
Retrieves a feature
@required @param id [String?] The ID of the feature. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::EntitlementsFeature]<p>Retrieves a feature</p> @required @param id [String?] The ID of the feature. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil
<p>Retrieves a feature</p> @required @param id [String?] The ID of the feature. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::EntitlementsFeature, Integer, Hash)] Stripe::EntitlementsFeature, response status code and response headers
<p>Retrieve a list of features</p>
@optional @param 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.
@optional @param 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.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param archived [Bool?] If set, filter results to only include features with the given archive status.
@optional @param lookup_key [String?] If set, filter results to only include features with the given lookup_key.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return [Tuple(Stripe::EntitlementsResourceFeatureList, Integer, Hash)] Stripe::EntitlementsResourceFeatureList, response status code and response headers
Creates a feature
@required @param lookup_key [String?] A unique key you provide as your own system identifier. This may be up to 80 characters. @required @param name [String?] The feature's name, for your own purpose, not meant to be displayable to the customer. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Hash(String, String)?] @return [Stripe::EntitlementsFeature]<p>Creates a feature</p> @required @param lookup_key [String?] A unique key you provide as your own system identifier. This may be up to 80 characters. @required @param name [String?] The feature's name, for your own purpose, not meant to be displayable to the customer. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Hash(String, String)?] @return nil
Update a feature’s metadata or permanently deactivate it.
@required @param id [String?] @optional @param active [Bool?] Inactive features cannot be attached to new products and will not be returned from the features list endpoint. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Stripe::PostEntitlementsFeaturesIdRequestMetadata?] @optional @param name [String?] The feature's name, for your own purpose, not meant to be displayable to the customer. @return [Stripe::EntitlementsFeature]<p>Update a feature’s metadata or permanently deactivate it.</p> @required @param id [String?] @optional @param active [Bool?] Inactive features cannot be attached to new products and will not be returned from the features list endpoint. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Stripe::PostEntitlementsFeaturesIdRequestMetadata?] @optional @param name [String?] The feature's name, for your own purpose, not meant to be displayable to the customer. @return nil
<p>Update a feature’s metadata or permanently deactivate it.</p> @required @param id [String?] @optional @param active [Bool?] Inactive features cannot be attached to new products and will not be returned from the features list endpoint. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Stripe::PostEntitlementsFeaturesIdRequestMetadata?] @optional @param name [String?] The feature's name, for your own purpose, not meant to be displayable to the customer. @return [Tuple(Stripe::EntitlementsFeature, Integer, Hash)] Stripe::EntitlementsFeature, response status code and response headers
<p>Creates a feature</p> @required @param lookup_key [String?] A unique key you provide as your own system identifier. This may be up to 80 characters. @required @param name [String?] The feature's name, for your own purpose, not meant to be displayable to the customer. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Hash(String, String)?] @return [Tuple(Stripe::EntitlementsFeature, Integer, Hash)] Stripe::EntitlementsFeature, response status code and response headers