User subscription details

GET /v0/users/me/subscription

Get subscription details for the authenticated user.

Responses

End user subscription details

Schema

epidemicSound object required
hasActiveSubscription boolean required
is true if the user has an active subscription and false if the user has no active subscription.
subscriptionExpiresAt date-time nullable required
if the subscription has been canceled, but is not yet expired, this will return the expiry datetime. In all other cases this will be null.

{
  "epidemicSound": {
    "hasActiveSubscription": true,
    "subscriptionExpiresAt": "2024-06-18T13:32:49.632Z"
  }
}

{
  "epidemicSound": {
    "hasActiveSubscription": true,
    "subscriptionExpiresAt": "2024-07-17T23:22:48Z"
  }
}

Bad request.

Schema

message string required
Human readable message
errors object[]
Array [
key string required
Error key
messages string[] required
Error messages
]

{
  "message": "string",
  "errors": [
    {
      "key": "string",
      "messages": [
        "string"
      ]
    }
  ]
}

{
  "message": "Bad request"
}

Unauthorized. Most likely your access token has expired.

Schema

message string required
Human readable message
errors object[]
Array [
key string required
Error key
messages string[] required
Error messages
]

{
  "message": "string",
  "errors": [
    {
      "key": "string",
      "messages": [
        "string"
      ]
    }
  ]
}

{
  "message": "Invalid credentials"
}

Rate limit exceeded.

Schema

message string required
Human readable message
errors object[]
Array [
key string required
Error key
messages string[] required
Error messages
]

{
  "message": "string",
  "errors": [
    {
      "key": "string",
      "messages": [
        "string"
      ]
    }
  ]
}

{
  "message": "Rate limit exceeded"
}