API reference
Test mode. Use your secret key on your server; live processing is currently disabled.
https://api.knoxapi.comSend 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/reviews
List all open reviews
Returns a list of Review objects that have open set to true. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
Request parameters
| Parameter | Location | Type | Description |
|---|---|---|---|
created | query | one of multiple schemas | Only return reviews that were created during the given date interval. |
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 review | |
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/reviews/{review}
Retrieve a review
Retrieves a Review object.
Request parameters
| Parameter | Location | Type | Description |
|---|---|---|---|
expand | query | array of string | Specifies which fields in the response should be expanded. |
review | path | string |
object. See the OpenAPI specification for the complete schema.
Responses
HTTP 200: Successful response.
| Field | Type | Description |
|---|---|---|
billing_zip | string | The ZIP or postal code of the card used, if applicable. |
charge | one of multiple schemas | The charge associated with this review. |
closed_reason | string | The reason the review was closed, or null if it has not yet been closed. One of `approved`, `refunded`, `refunded_as_fraud`, `disputed`, `redacted`, `canceled`, `payment_never_settled`, or `acknowledged`. |
created required | integer | Time at which the object was created. Measured in seconds since the Unix epoch. |
id required | string | Unique identifier for the object. |
ip_address | string | The IP address where the payment originated. |
ip_address_location | one of multiple schemas | Information related to the location of the payment. Note that this information is an approximation and attempts to locate the nearest population center - it should not be used to determine a specific address. |
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`. |
object required | string | String representing the object's type. Objects of the same type share the same value. |
open required | boolean | If `true`, the review needs action. |
opened_reason required | string | The reason the review was opened. One of `rule` or `manual`. |
payment_intent | one of multiple schemas | The PaymentIntent ID associated with this review, if one exists. |
reason required | string | The reason the review is currently open or closed. One of `rule`, `manual`, `approved`, `refunded`, `refunded_as_fraud`, `disputed`, `redacted`, `canceled`, `payment_never_settled`, or `acknowledged`. |
session | one of multiple schemas | Information related to the browsing session of the user who initiated the payment. |
HTTP default: Error response.
| Field | Type | Description |
|---|---|---|
error required | api_errors |
POST /v1/reviews/{review}/approve
Approve a review
Approves a Review object, closing it and removing it from the list of reviews.
Request parameters
| Parameter | Location | Type | Description |
|---|---|---|---|
review | path | string |
| Field | Type | Description |
|---|---|---|
expand | array of string | Specifies which fields in the response should be expanded. |
Responses
HTTP 200: Successful response.
| Field | Type | Description |
|---|---|---|
billing_zip | string | The ZIP or postal code of the card used, if applicable. |
charge | one of multiple schemas | The charge associated with this review. |
closed_reason | string | The reason the review was closed, or null if it has not yet been closed. One of `approved`, `refunded`, `refunded_as_fraud`, `disputed`, `redacted`, `canceled`, `payment_never_settled`, or `acknowledged`. |
created required | integer | Time at which the object was created. Measured in seconds since the Unix epoch. |
id required | string | Unique identifier for the object. |
ip_address | string | The IP address where the payment originated. |
ip_address_location | one of multiple schemas | Information related to the location of the payment. Note that this information is an approximation and attempts to locate the nearest population center - it should not be used to determine a specific address. |
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`. |
object required | string | String representing the object's type. Objects of the same type share the same value. |
open required | boolean | If `true`, the review needs action. |
opened_reason required | string | The reason the review was opened. One of `rule` or `manual`. |
payment_intent | one of multiple schemas | The PaymentIntent ID associated with this review, if one exists. |
reason required | string | The reason the review is currently open or closed. One of `rule`, `manual`, `approved`, `refunded`, `refunded_as_fraud`, `disputed`, `redacted`, `canceled`, `payment_never_settled`, or `acknowledged`. |
session | one of multiple schemas | Information related to the browsing session of the user who initiated the payment. |
HTTP default: Error response.
| Field | Type | Description |
|---|---|---|
error required | api_errors |