Scaleway · Schema

scaleway.transactional_email.v1alpha1.OfferSubscription

AICloud ComputingContainersDatabaseEuropean CloudInfrastructureKubernetesServerlessStorage

Properties

Name	Type	Description
organization_id	string	ID of the offer-subscription Organization.
project_id	string	ID of the offer-subscription Project.
offer_name	string	Name of the offer associated with the Project.
subscribed_at	string	Date and time of the subscription. (RFC 3339 format)
cancellation_available_at	string	Date and time of the end of the offer-subscription commitment. (RFC 3339 format)
sla	number	Service Level Agreement percentage of the offer-subscription.
max_domains	integer	Max number of domains that can be associated with the offer-subscription for a particular Project.
max_dedicated_ips	integer	Max number of dedicated IPs that can be associated with the offer-subscription for a particular Project.
max_webhooks_per_domain	integer	Max number of webhooks that can be associated with the offer-subscription for a particular Project.
max_custom_blocklists_per_domain	integer	Max number of custom blocklists that can be associated with the offer-subscription for a particular Project.
included_monthly_emails	integer	Number of emails included in the offer-subscription per month.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/scaleway.transactional_email.v1alpha1.OfferSubscription",
  "title": "scaleway.transactional_email.v1alpha1.OfferSubscription",
  "type": "object",
  "properties": {
    "organization_id": {
      "type": "string",
      "description": "ID of the offer-subscription Organization."
    },
    "project_id": {
      "type": "string",
      "description": "ID of the offer-subscription Project."
    },
    "offer_name": {
      "type": "string",
      "description": "Name of the offer associated with the Project.",
      "enum": [
        "unknown_name",
        "essential",
        "scale"
      ],
      "x-enum-descriptions": {
        "values": {
          "unknown_name": "If unspecified, the offer name is unknown by default",
          "essential": "The 'essential' offer",
          "scale": "The 'scale' offer"
        }
      },
      "default": "unknown_name"
    },
    "subscribed_at": {
      "type": "string",
      "description": "Date and time of the subscription. (RFC 3339 format)",
      "format": "date-time",
      "example": "2022-03-22T12:34:56.123456Z",
      "nullable": true
    },
    "cancellation_available_at": {
      "type": "string",
      "description": "Date and time of the end of the offer-subscription commitment. (RFC 3339 format)",
      "format": "date-time",
      "example": "2022-03-22T12:34:56.123456Z",
      "nullable": true
    },
    "sla": {
      "type": "number",
      "description": "Service Level Agreement percentage of the offer-subscription.",
      "format": "float"
    },
    "max_domains": {
      "type": "integer",
      "description": "Max number of domains that can be associated with the offer-subscription for a particular Project.",
      "format": "int32"
    },
    "max_dedicated_ips": {
      "type": "integer",
      "description": "Max number of dedicated IPs that can be associated with the offer-subscription for a particular Project.",
      "format": "int32"
    },
    "max_webhooks_per_domain": {
      "type": "integer",
      "description": "Max number of webhooks that can be associated with the offer-subscription for a particular Project.",
      "format": "int32"
    },
    "max_custom_blocklists_per_domain": {
      "type": "integer",
      "description": "Max number of custom blocklists that can be associated with the offer-subscription for a particular Project.",
      "format": "int32"
    },
    "included_monthly_emails": {
      "type": "integer",
      "description": "Number of emails included in the offer-subscription per month.",
      "format": "int32"
    }
  },
  "x-properties-order": [
    "organization_id",
    "project_id",
    "offer_name",
    "subscribed_at",
    "cancellation_available_at",
    "sla",
    "max_domains",
    "max_dedicated_ips",
    "max_webhooks_per_domain",
    "max_custom_blocklists_per_domain",
    "included_monthly_emails"
  ]
}