Get Billing Status via API

This method allows you to view the billing status of your DeployHQ account, including plan details and any scheduled changes.

Tip: You can explore and test this endpoint interactively using our OpenAPI documentation.

URL

/account/billing_status

HTTP Method

GET

Supported Parameters

This endpoint does not accept any parameters.

Example cURL Request

curl -H "Content-type: application/json" \
-H "Accept: application/json" \
--user adam@atechmedia.com:my-api-key \
https://test.deployhq.com/account/billing_status

Example Response

{
  "package": "premium_2020",
  "frequency": 1,
  "trialling": false,
  "suspended": false,
  "scheduled_change": null
}

Notes

• The package field indicates the current plan the account is on
• The frequency field indicates the billing cycle in months (e.g. 1 for monthly, 12 for yearly)
• The trialling field indicates whether the account is currently on a trial period
• The suspended field indicates whether the account has been suspended
• The scheduled_change field will contain details of any upcoming plan change, or null if no change is scheduled