User subscription details

GET 
/v0/users/me/subscription

Get subscription details for the authenticated user.

Responses

200

End user subscription details

application/json

Schema

Schema

epidemicSound

object

required

hasActiveSubscription booleanrequired

is true if the user has an active subscription and false if the user has no active subscription.

subscriptionExpiresAt date-timenullablerequired

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.

Example (from schema)

{
  "epidemicSound": {
    "hasActiveSubscription": true,
    "subscriptionExpiresAt": "2024-07-29T15:51:28.071Z"
  }
}

Example

{
  "epidemicSound": {
    "hasActiveSubscription": true,
    "subscriptionExpiresAt": "2024-11-10T07:29:34Z"
  }
}

400

Bad request.

application/json

Schema

Schema

message stringrequired

Human readable message

errors

object[]

Array [

key stringrequired

Error key

messages string[]required

Error messages

]

Example (from schema)

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

Example

{
  "message": "Bad request"
}

401

Unauthorized. Most likely your access token has expired.

application/json

Schema

Schema

message stringrequired

Human readable message

errors

object[]

Array [

key stringrequired

Error key

messages string[]required

Error messages

]

Example (from schema)

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

Example

{
  "message": "Invalid credentials"
}

429

Rate limit exceeded.

application/json

Schema

Schema

message stringrequired

Human readable message

errors

object[]

Array [

key stringrequired

Error key

messages string[]required

Error messages

]

Example (from schema)

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

Example

{
  "message": "Rate limit exceeded"
}

Loading...