DELETE/partners/customers/{domainId}
Deletes customer information (cancels all its subscriptions and platforms).
This API operation does not delete a partner domain.
If a partner’s customer is deleted, all its subscriptions and options will be canceled.
A paying customer will be billed for the services that have been used until the day before being deleted, along with a cancellation fee, on the next invoice. Therefore, to cancel a paid subscription at the end of the contract, you need to delete the customer on the day after the contract ends.
- If the customer has installed paid apps that do not allow real-time billing, it is not deleted immediately; the subscription becomes pending cancellation to determine Option Plus charges, and 202 Accepted is returned.
- If the customer’s subscription is pending cancellation, the status of Get a subscription becomes SUSPENDED_WITHDRAWAL, and the subscription will be deleted (canceled) on the withdrawalDate of Get a subscription.
- No additional charges other than Option Plus charges will be incurred during the pending cancellation period. Also, pending cancellation cannot be canceled.
- The subscription becomes pending cancellation on the day before the customer is deleted; if it is deleted between the 2nd and 24th, the last billing day will be the 1st day of the following month, and the subscription will be canceled on the 2nd day of the following month.
- If the customer is deleted from the 25th to the 1st of the following month, the customer will be possibly billed only for Option Plus on the 1st day of the following month, and the subscription will be canceled on the 2nd day of that month.
- Therefore, if you want to set the last billing to occur in the month following the deletion (cancellation), you need to delete the customer from the 2nd to the 24th of the current month.
- If you want to cancel the subscription from the 25th to the 1st of the following month and set the last billing to occur on the 1st of the following month, set a scheduled cancellation (type: DELETE) until the 24th of the month using Update part of usage status.
- If the customer has not installed paid apps that do not allow real-time billing, the customer’s subscription will be deleted (canceled) immediately, and 204 No Content is returned.
- Paid apps that do not support real-time billing include:
- Delivery service (Yamato Transport)
Authorization
oauth2
Scope
partner
DELETEhttps://www.worksapis.com/v1.0/partners/customers/{domainId}
| Parameter | Type | Description | | domainId | integer | required example : 10000001 |
| Header | type | Description | | Authorization | string | required |
Response
HTTP 202
HTTP 204