Get Billing Status

GET

/billing/status

const url = 'https://api.mengi.cloud/billing/status';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.mengi.cloud/billing/status

Get current billing status including mandate verification, credit limit, and usage.

Responses

200

Successful Response

application/json

BillingStatusResponse

object

has_subscription

required

Has Subscription

boolean

mandate_verified

required

Mandate Verified

boolean

credit_limit

required

Credit Limit

number

balance

required

Balance

number

available_credit

required

Available Credit

number

status

Any of:

string
null

string

payment_failures

Payment Failures

integer

suspended_at

Any of:

string
null

string format: date-time

current_period_usage

Current Period Usage

number

estimated_monthly_cost

Estimated Monthly Cost

number

Example

{
  "payment_failures": 0,
  "current_period_usage": 0,
  "estimated_monthly_cost": 0
}