Automattic / Automattic/wp-calypso

Task: Document Purchase delete and cancel API endpoints

Open
#55,828 0 comments 0 reactions 0 assignees View on GitHub
[Platform] Atomic Task
Dominant language
TypeScript
Stars
12.6k
Forks
2k
Avg merge
1d 17h
Merged PRs (30d)
552

Description

### Details

Currently, the parameters for V1 API endpoints /me/purchases/:purchase_id/cancel and /me/purchases/:purchase_id/delete are not documented. While `delete` only requires a purchase_id, the cancellation endpoint requires multiple parameters, based on the product it has to cancel.

It's important to note the the V1 endpoints might be replaced by new V2 endpoints that also have documented with the same parameters.

### Checklist

_No response_

### Related

_No response_

Contributor guide

Open the contributing guide

Research direction

Start by locating the documentation or endpoint definitions for /me/purchases/:purchase_id/cancel and /me/purchases/:purchase_id/delete. Confirm whether the V1 endpoints remain in scope or are superseded by V2, then identify the cancellation parameters for each product. Done means both endpoints document their required parameters, including purchase_id.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.