Scaleway logo
Transactional Email API
Transactional Email API

offer-subscriptions

Download schema

This section allows you to manage and get information about your project offer subscriptions.

Get information about subscribed offers

GET
https://api.scaleway.com
/transactional-email/v1alpha1/regions/{region}/offer-subscriptions

Retrieve information about the offers you are subscribed to using the project_id and region parameters.

Get information about subscribed offers › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par

Get information about subscribed offers › query Parameters

page
​integer · int32

(Optional) Requested page number. Value must be greater or equal to 1.

page_size
​integer · uint32

(Optional) Requested page size. Value must be between 1 and 100.

(Optional) Name of the offer associated with the Project.

Enum values:
unknown_name
essential
scale
Default: unknown_name

Get information about subscribed offers › Responses

200
scaleway.transactional_email.v1alpha1.ListOfferSubscriptionsResponse
total_count
​integer · uint64

Number of offer-subscriptions matching the requested criteria.

Single page of offer-subscriptions matching the requested criteria.

Update a subscribed offer

PATCH
https://api.scaleway.com
/transactional-email/v1alpha1/regions/{region}/offer-subscriptions

Update a subscribed offer › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par

Update a subscribed offer › Request Body

project_id
​string

ID of the Project. (UUID format)

Name of the offer-subscription.

Enum values:
unknown_name
essential
scale
Default: unknown_name

Update a subscribed offer › Responses

200
scaleway.transactional_email.v1alpha1.OfferSubscription
organization_id
​string

ID of the offer-subscription Organization.

project_id
​string

ID of the offer-subscription Project.

Name of the offer associated with the Project.

Enum values:
unknown_name
essential
scale
Default: unknown_name
subscribed_at
​string | null · date-time

Date and time of the subscription. (RFC 3339 format)

cancellation_available_at
​string | null · date-time

Date and time of the end of the offer-subscription commitment. (RFC 3339 format)

sla
​number · float

Service Level Agreement percentage of the offer-subscription.

max_domains
​integer · int32

Max number of domains that can be associated with the offer-subscription for a particular Project.

max_dedicated_ips
​integer · int32

Max number of dedicated IPs that can be associated with the offer-subscription for a particular Project.

max_webhooks_per_domain
​integer · int32

Max number of webhooks that can be associated with the offer-subscription for a particular Project.

max_custom_blocklists_per_domain
​integer · int32

Max number of custom blocklists that can be associated with the offer-subscription for a particular Project.

included_monthly_emails
​integer · int32

Number of emails included in the offer-subscription per month.

offerspools