Package com.stripe.service.v2.iam
Class ApiKeyService
java.lang.Object
com.stripe.net.ApiService
com.stripe.service.v2.iam.ApiKeyService
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreate(ApiKeyCreateParams params) Create an API key.create(ApiKeyCreateParams params, RequestOptions options) Create an API key.Expire an API key.expire(String id, RequestOptions options) Expire an API key.list()List all API keys of an account.list(RequestOptions options) List all API keys of an account.list(ApiKeyListParams params) List all API keys of an account.list(ApiKeyListParams params, RequestOptions options) List all API keys of an account.Retrieve an API key.retrieve(String id, RequestOptions options) Retrieve an API key.Rotate an API key.rotate(String id, RequestOptions options) Rotate an API key.rotate(String id, ApiKeyRotateParams params) Rotate an API key.rotate(String id, ApiKeyRotateParams params, RequestOptions options) Rotate an API key.Update an API key.update(String id, RequestOptions options) Update an API key.update(String id, ApiKeyUpdateParams params) Update an API key.update(String id, ApiKeyUpdateParams params, RequestOptions options) Update an API key.Methods inherited from class com.stripe.net.ApiService
getResponseGetter, request, requestStream
-
Constructor Details
-
ApiKeyService
-
-
Method Details
-
list
List all API keys of an account.- Throws:
StripeException
-
list
List all API keys of an account.- Throws:
StripeException
-
list
List all API keys of an account.- Throws:
StripeException
-
list
public StripeCollection<ApiKey> list(ApiKeyListParams params, RequestOptions options) throws StripeException List all API keys of an account.- Throws:
StripeException
-
create
Create an API key. To create a secret key in livemode, a public key for encryption must be provided.- Throws:
StripeException
-
create
Create an API key. To create a secret key in livemode, a public key for encryption must be provided.- Throws:
StripeException
-
retrieve
Retrieve an API key. For livemode secret keys, secret tokens are only returned on creation, and never returned here.- Throws:
StripeException
-
retrieve
Retrieve an API key. For livemode secret keys, secret tokens are only returned on creation, and never returned here.- Throws:
StripeException
-
update
Update an API key. Only parameters that are specified in the request will be updated.- Throws:
StripeException
-
update
Update an API key. Only parameters that are specified in the request will be updated.- Throws:
StripeException
-
update
Update an API key. Only parameters that are specified in the request will be updated.- Throws:
StripeException
-
update
public ApiKey update(String id, ApiKeyUpdateParams params, RequestOptions options) throws StripeException Update an API key. Only parameters that are specified in the request will be updated.- Throws:
StripeException
-
expire
Expire an API key. The specified key becomes invalid immediately.- Throws:
StripeException
-
expire
Expire an API key. The specified key becomes invalid immediately.- Throws:
StripeException
-
rotate
Rotate an API key. A new key with the same properties is created and returned. The existing key is expired immediately, unless an expiry time is specified.- Throws:
StripeException
-
rotate
Rotate an API key. A new key with the same properties is created and returned. The existing key is expired immediately, unless an expiry time is specified.- Throws:
StripeException
-
rotate
Rotate an API key. A new key with the same properties is created and returned. The existing key is expired immediately, unless an expiry time is specified.- Throws:
StripeException
-
rotate
public ApiKey rotate(String id, ApiKeyRotateParams params, RequestOptions options) throws StripeException Rotate an API key. A new key with the same properties is created and returned. The existing key is expired immediately, unless an expiry time is specified.- Throws:
StripeException
-