API reference

Test mode. Use your secret key on your server; live processing is currently disabled.

https://api.knoxapi.com

Send form-encoded requests with Authorization: Bearer sk_test_....

Complete OpenAPI specification · Integration guide

Operations and schemas are based on the pinned Stripe OpenAPI specification (MIT). Nested object definitions and enums are available in the complete specification.

GET /v1/entitlements/active_entitlements

List all active entitlements

Retrieve a list of active entitlements for a customer

Request parameters

Parameter	Location	Type	Description
`customer`	query	string	The ID of the customer.
`ending_before`	query	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`	query	array of string	Specifies which fields in the response should be expanded.
`limit`	query	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`	query	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.

object. See the OpenAPI specification for the complete schema.

Responses

HTTP 200: Successful response.

Field	Type	Description
`data` required	array of entitlements.active_entitlement
`has_more` required	boolean	True if this list has another page of items after this one that can be fetched.
`object` required	string	String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
`url` required	string	The URL where this list can be accessed.

HTTP default: Error response.

Field	Type	Description
`error` required	api_errors

GET /v1/entitlements/features

List all features

Retrieve a list of features

Request parameters

Parameter	Location	Type	Description
`archived`	query	boolean	If set, filter results to only include features with the given archive status.
`ending_before`	query	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`	query	array of string	Specifies which fields in the response should be expanded.
`limit`	query	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`	query	string	If set, filter results to only include features with the given lookup_key.
`starting_after`	query	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.

object. See the OpenAPI specification for the complete schema.

Responses

HTTP 200: Successful response.

Field	Type	Description
`data` required	array of entitlements.feature
`has_more` required	boolean	True if this list has another page of items after this one that can be fetched.
`object` required	string	String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
`url` required	string	The URL where this list can be accessed.

HTTP default: Error response.

Field	Type	Description
`error` required	api_errors

POST /v1/entitlements/features

Create a feature

Creates a feature

Request parameters

Field	Type	Description
`expand`	array of string	Specifies which fields in the response should be expanded.
`lookup_key` required	string	A unique key you provide as your own system identifier. This may be up to 80 characters.
`metadata`	object	Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
`name` required	string	The feature's name, for your own purpose, not meant to be displayable to the customer.

Responses

HTTP 200: Successful response.

Field	Type	Description
`active` required	boolean	Inactive features cannot be attached to new products and will not be returned from the features list endpoint.
`id` required	string	Unique identifier for the object.
`livemode` required	boolean	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
`lookup_key` required	string	A unique key you provide as your own system identifier. This may be up to 80 characters.
`metadata` required	object	Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
`name` required	string	The feature's name, for your own purpose, not meant to be displayable to the customer.
`object` required	string	String representing the object's type. Objects of the same type share the same value.

HTTP default: Error response.

Field	Type	Description
`error` required	api_errors

GET /v1/entitlements/active_entitlements/{id}

Retrieve an active entitlement

Request parameters

Parameter	Location	Type	Description
`expand`	query	array of string	Specifies which fields in the response should be expanded.
`id`	path	string	The ID of the entitlement.

object. See the OpenAPI specification for the complete schema.

Responses

HTTP 200: Successful response.

Field	Type	Description
`feature` required	one of multiple schemas	The [Feature](https://docs.stripe.com/api/entitlements/feature) that the customer is entitled to.
`id` required	string	Unique identifier for the object.
`livemode` required	boolean	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
`lookup_key` required	string	A unique key you provide as your own system identifier. This may be up to 80 characters.
`object` required	string	String representing the object's type. Objects of the same type share the same value.

HTTP default: Error response.

Field	Type	Description
`error` required	api_errors

GET /v1/entitlements/features/{id}

Retrieve a feature

Retrieves a feature

Request parameters

Parameter	Location	Type	Description
`expand`	query	array of string	Specifies which fields in the response should be expanded.
`id`	path	string	The ID of the feature.

object. See the OpenAPI specification for the complete schema.

Responses

HTTP 200: Successful response.

Field	Type	Description
`active` required	boolean	Inactive features cannot be attached to new products and will not be returned from the features list endpoint.
`id` required	string	Unique identifier for the object.
`livemode` required	boolean	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
`lookup_key` required	string	A unique key you provide as your own system identifier. This may be up to 80 characters.
`metadata` required	object	Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
`name` required	string	The feature's name, for your own purpose, not meant to be displayable to the customer.
`object` required	string	String representing the object's type. Objects of the same type share the same value.

HTTP default: Error response.

Field	Type	Description
`error` required	api_errors

POST /v1/entitlements/features/{id}

Updates a feature

Update a feature’s metadata or permanently deactivate it.

Request parameters

Parameter	Location	Type	Description
`id`	path	string

Field	Type	Description
`active`	boolean	Inactive features cannot be attached to new products and will not be returned from the features list endpoint.
`expand`	array of string	Specifies which fields in the response should be expanded.
`metadata`	one of multiple schemas	Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
`name`	string	The feature's name, for your own purpose, not meant to be displayable to the customer.

Responses

HTTP 200: Successful response.

Field	Type	Description
`active` required	boolean	Inactive features cannot be attached to new products and will not be returned from the features list endpoint.
`id` required	string	Unique identifier for the object.
`livemode` required	boolean	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
`lookup_key` required	string	A unique key you provide as your own system identifier. This may be up to 80 characters.
`metadata` required	object	Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
`name` required	string	The feature's name, for your own purpose, not meant to be displayable to the customer.
`object` required	string	String representing the object's type. Objects of the same type share the same value.

HTTP default: Error response.

Field	Type	Description
`error` required	api_errors