Skip to content
WaalaxyWaalaxy AI API

Get billing

GET
/v1/billing
curl --request GET \
  --url https://developers.waalaxy.ai/v1/billing \
  --header 'Authorization: Bearer <token>'

Get the subscription state and the plan catalog

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
status
required
string
Allowed value: success
data
required
object
subscription
required
object
isSubscribed
required
boolean
paymentFailed
required
boolean
trialEnded
required
boolean
accessKind
required
string | null
Allowed values: alpha admin
billingCurrency
required
string
Allowed values: eur usd
status
required
string | null
seats
required
integer
>= -9007199254740991 <= 9007199254740991
paidSeats
required
integer
>= -9007199254740991 <= 9007199254740991
complimentarySeats
required
integer
>= -9007199254740991 <= 9007199254740991
usedSeats
required
integer
>= -9007199254740991 <= 9007199254740991
billingPrice
required
object
billingPeriod
required
string
Allowed values: monthly yearly
currency
required
string
Allowed values: eur usd
unitAmount
required
integer
>= -9007199254740991 <= 9007199254740991
product
required
object
name
required
string
>= 1 characters
currentPeriodEnd
required
string | null format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
cancelAt
required
string | null format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
cancelAtPeriodEnd
required
boolean
nextPaymentAmount
required
integer | null
>= -9007199254740991 <= 9007199254740991
nextPaymentDate
required
string | null format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
nextPaymentDiscount
required
object
code
required
string
>= 1 characters
name
required
string | null
>= 1 characters
duration
required
string
Allowed values: once repeating forever
durationInMonths
required
integer | null
> 0 <= 9007199254740991
percentOff
required
number | null
> 0 <= 100
amountOff
required
integer | null
> 0 <= 9007199254740991
redeemBy
required
string | null format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
endsAt
required
string | null format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
regularAmount
required
integer
<= 9007199254740991
discountAmount
required
integer
<= 9007199254740991
catalog
required
Array<object>
object
name
required
string
>= 1 characters
prices
required
Array<object>
object
billingPeriod
required
string
Allowed values: monthly yearly
currency
required
string
Allowed values: eur usd
unitAmount
required
integer
>= -9007199254740991 <= 9007199254740991
Example
{
  "status": "success",
  "data": {
    "subscription": {
      "accessKind": "alpha",
      "billingCurrency": "eur",
      "billingPrice": {
        "billingPeriod": "monthly",
        "currency": "eur"
      },
      "nextPaymentDiscount": {
        "duration": "once"
      }
    },
    "catalog": [
      {
        "prices": [
          {
            "billingPeriod": "monthly",
            "currency": "eur"
          }
        ]
      }
    ]
  }
}

400

Section titled “400”

Error, see Errors and rate limits

Media typeapplication/json
object
status
required
string
Allowed value: error
error
required
object
message
required
string
code
string
requestId
string
Example
{
  "status": "error"
}