GetSubscriptionStateReport

Get subscription state report for a specific month.

Path Parameters

• domainId string required

  Possible values: Value must match regular expression ^([A-Za-z0-9]{8}-){0,6}[A-Za-z0-9]{8}$

  Domain the resource belongs to. Used to determine which users have access to the resource.

• yearMonth string required

  Possible values: Value must match regular expression [0-9]{4}-[0-9]{2}

  Year and month, written in YYYY-MM format.

Responses

• 200
• 400
• 401
• 404
• 500

---

The requested report. Will always be gzipped.

Response Headers

• Content-Disposition string

application/gzip

• Schema

---

Schema

• string binary

Bad request. The server cannot process the request.

application/json

• Schema
• Example (from schema)

---

Schema

• description string

  Human readable description of the error

• errorCode string

  String constant describing the error.

• timestamp date-time

  ISO 8601 timestamp specifying when error occurred.

{
  "description": true,
  "errorCode": true,
  "timestamp": "2024-10-17"
}

Invalid or missing ID Token (JWT).

Entity not found.

application/json

• Schema
• Example (from schema)

---

Schema

• description string

  Human readable description of the error

• errorCode string

  String constant describing the error.

• timestamp date-time

  ISO 8601 timestamp specifying when error occurred.

{
  "description": "Requested resource does not exist.",
  "errorCode": "RESOURCE_NOT_FOUND",
  "timestamp": "2024-10-17"
}

Internal server error.

application/json

• Schema
• Example (from schema)

---

Schema

• description string

  Human readable description of the error

• errorCode string

  String constant describing the error.

• timestamp date-time

  ISO 8601 timestamp specifying when error occurred.

{
  "description": true,
  "errorCode": true,
  "timestamp": "2024-10-17"
}

Loading...