How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Yoast

Yoast Subscription Provisioning API

Create, read and manage provisioned Yoast subscriptions

Documentation Provider Profile APIs.io OpenAPI GitHub

Yoast Subscription Provisioning API is one of 12 APIs that Yoast publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Subscription Provisioning. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 6 paths, and defines 4 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://my.yoast.com.

6 operations 6 paths 4 schemas 1 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://{your-site}
Authentication
HTTP Basic
Contact
Yoast Developer Portal
Resource Areas
1

Authentication & Security 1

Yoast Subscription Provisioning API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basic).

  • basic — HTTP Basic authentication with provisioner credentials issued by Yoast. The password can be rotated with POST /api/provisioning/account/regenerate-token.

Paths & Operations 6

Across 6 paths, the API surfaces 6 operations — 1 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Subscription Provisioning 6

Create, read and manage provisioned Yoast subscriptions

POST
/api/provisioning/subscriptions/create
Create a subscription
subscriptionProvisioningControllerCreate body → 200401
GET
/api/provisioning/subscriptions/{id}
Get a subscription
subscriptionProvisioningControllerGetOne 1 param → 200401404
POST
/api/provisioning/subscriptions/{id}/renew
Renew a subscription
subscriptionProvisioningControllerRenewSubscription 1 param → 200401404
POST
/api/provisioning/subscriptions/{id}/cancel
Cancel a single subscription
subscriptionProvisioningControllerCancelSubscription 1 param body → 200401404
POST
/api/provisioning/subscriptions/{id}/refund
Refund a single subscription
subscriptionProvisioningControllerRefundSubscription 1 param → 200401404
POST
/api/provisioning/subscriptions/{id}/set-site
Link a subscription to a site
subscriptionProvisioningControllerSetSiteForSubscription 1 param body → 200401404

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are SubscriptionProvisioningResponseDto (7 properties), CreateProvisionedSubscriptionDto (5 properties), CancelProvisionedSubscriptionDto (1 property), SetProvisionedSiteDto (1 property). Each schema is shown below with its type and property counts.

CreateProvisionedSubscriptionDto
object
Payload used to create a subscription for a customer
5 properties
SubscriptionProvisioningResponseDto
object
A provisioned Yoast subscription
7 properties
SetProvisionedSiteDto
object
The site to link the subscription to
1 property
CancelProvisionedSubscriptionDto
object
Cancellation options
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yoast-subscription-provisioning-api-openapi.yml Raw ↑

Other APIs Yoast publishes across the network.

Yoast Surfaces API
AE Profile APIs.io
Yoast Metadata API
AE Profile APIs.io
Yoast Schema API
AE Profile APIs.io
Yoast Pages API
AE Profile APIs.io
Yoast Posts API
AE Profile APIs.io
Yoast SEO Head API
AE Profile APIs.io
Yoast SEO Abilities API
AE Profile APIs.io
Yoast Provisioning Account API
AE Profile APIs.io
Yoast Provisioning Downloads API
AE Profile APIs.io
Yoast Provisioning Users API
AE Profile APIs.io
Yoast Schema Aggregator API
AE Profile APIs.io
#Subscription Provisioning
← Back to Y APIs
API Details
ID
yoast:yoast-subscription-provisioning-api
Base URL
https://{your-site}
Docs
https://developer.yoast.com/customization/apis/surfaces-api/
Provider
Yoast
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=yoast-subscription-provisioning-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/yoast-subscription-provisioning-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Yoast Subscription Provisioning API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.