Get Clearance Plan Template
GET/api/v2/clearance-plans/template
Get the default "Standard 3-step" markdown ladder (25% straight away, 40% once sell-through is behind plan after 3 weeks, 60% 21 days later) and the catalogue of step triggers with their meaning. A plan created without steps uses this ladder.
products:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Response fields: name, steps (discount_pct, trigger_type, trigger_params — ready to send as steps when creating a plan), triggers (value, label, help).
Requires a Bearer token with the products read/write scope and the products.show permission.
Request
Responses
- 200
- 401
- 403
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.