Class: Mailtrap::BillingAPI

Inherits:

Object

• Object
• Mailtrap::BillingAPI

Includes:

BaseAPI

Defined in:

lib/mailtrap/billing_api.rb

Instance Attribute Summary

Attributes included from BaseAPI

#account_id, #client

Instance Method Summary

• #usage ⇒ BillingUsage

  Get current billing cycle usage.

Methods included from BaseAPI

included, #initialize

Instance Method Details

#usage ⇒ BillingUsage

Get current billing cycle usage

Returns:

• (BillingUsage) —

  Billing usage data for account

Raises:

• (Mailtrap::Error) —

  If the API request fails with a client or server error

• (Mailtrap::AuthorizationError) —

  If the API key is invalid

• (Mailtrap::RejectionError) —

  If the server refuses to process the request

• (Mailtrap::RateLimitError) —

  If too many requests are made

# File 'lib/mailtrap/billing_api.rb', line 13

def usage
  response = client.get("/api/accounts/#{account_id}/billing/usage")
  build_entity(response, BillingUsage)
end