Get subscription

GET /users/subscription

Fetch subscription information for the current ClickGUARD account

Available on: AuditGUARD AlertGUARD PremiumGUARD EliteGUARD

Responses

200

Successful operation
Hide response attributes Show response attributes array[object]
- billing_name string
  
  Name of the billing account holder
- billing_email string
  
  Email of the billing account holder
- billing_address string
  
  Address of the billing account holder
- plan_name string
  
  Name of the chosen subscription plan
- subscription_price number
  
  Subscription price in US dollars (cents)
- subscription_duration string
  
  Billing period of the subscription
  
  Values are monthly or yearly.
- next_billing_date string(date-time)
  
  Date and time of the next billing cycle

GET /users/subscription

curl \
 -X GET https://api.clickguard.com/users/subscription \
 -H "X-API-KEY: $API_KEY"

Response examples (200)

"{\n  \"billing_name\": \"John Doe\",\n  \"billing_email\": \"john@example.com\",\n  \"billing_address\": \"New Example Ave 6052\",\n  \"plan_name\": \"Elite GUARD\",\n  \"subscription_price\": 9900,\n  \"subscription_duration\": \"monthly\",\n  \"next_billing_date\": \"2020-01-24T14:00:01.726Z\"\n}"

Response examples (200)

[
  {
    "billing_name": "string",
    "billing_email": "string",
    "billing_address": "string",
    "plan_name": "string",
    "subscription_price": 42.0,
    "subscription_duration": "monthly",
    "next_billing_date": "2025-05-04T09:42:00Z"
  }
]