Skip to main content

ApiRateLimits

The ApiRateLimits class represents the rate limits of the GoCardless API.

Properties​

RequestLimit - int​

Indicates the maximum number of allowed requests within the defined time window. Usually populated in every response.

RemainingRequests - int​

Indicates the number of remaining requests you can make in the current time window. Usually populated in every response.

RemainingSecondsInTimeWindow - int​

Indicates the time remaining in the current time window (in seconds). Usually populated in every response.

RequestLimitAccountsEndpoint - int​

Indicates the maximum number of allowed requests to the AccountsEndpoint within the defined time window. Only populated in responses from the AccountsEndpoint.

RemainingRequestsAccountsEndpoint - int​

Indicates the number of remaining requests to the AccountsEndpoint you can make in the current time window. Only populated in responses from the AccountsEndpoint.

RemainingSecondsInTimeWindowAccountsEndpoint - int​

Indicates the time remaining in the current time window (in seconds) for requests to the AccountsEndpoint. Only populated in responses from the AccountsEndpoint.

Constructor​

public ApiRateLimits(int requestLimit, int remainingRequests, int remainingTimeInTimeWindow,
      int maxAccountRequests, int remainingAccountRequests, int remainingTimeInAccountTimeWindow)

Parameters​

requestLimit - int?​

Indicates the maximum number of allowed requests within the defined time window. Usually populated in every response.

remainingRequests - int?​

Indicates the number of remaining requests you can make in the current time window. Usually populated in every response.

remainingSecondsInTimeWindow - int?​

Indicates the time remaining in the current time window (in seconds). Usually populated in every response.

requestLimitAccountsEndpoint - int?​

Indicates the maximum number of allowed requests to the AccountsEndpoint within the defined time window. Only populated in responses from the AccountsEndpoint.

remainingRequestsAccountsEndpoint - int?​

Indicates the number of remaining requests to the AccountsEndpoint you can make in the current time window. Only populated in responses from the AccountsEndpoint.

remainingSecondsInTimeWindowAccountsEndpoint - int?​

Indicates the time remaining in the current time window (in seconds) for requests to the AccountsEndpoint. Only populated in responses from the AccountsEndpoint.