Clear Site Data
Clears all data from a test site asynchronously. This call is asynchronous and there may be a delay before the site data is fully deleted. If you are clearing site data for an automated test, you will need to build in a delay and/or check that there are no products, etc., in the site before proceeding.
This functionality will only work on sites in TEST mode. Attempts to perform this on sites in “live” mode will result in a response of 403 FORBIDDEN.
Authorization
BasicAuth The username is a Maxio Chargify API key. The password is x.
In: header
Query Parameters
all: Will clear all products, customers, and related subscriptions from the site.
customers: Will clear only customers and related subscriptions (leaving the products untouched) for the site.
Revenue will also be reset to 0.
Use in query cleanup_scope=all.
"all"Value in
- "all"
- "customers"
Response Body
curl -X POST "https://example.com/sites/clear_data.json"Read Site GET
Retrieves site data. For more information, see [Sites](https://maxio.zendesk.com/hc/en-us/sections/24250550707085-Sites) in the product documentation. Specifically, the [Clearing Site Data](https://maxio.zendesk.com/hc/en-us/articles/24250617028365-Clearing-Site-Data) section is relevant to this endpoint. #### Relationship invoicing enabled If the site has Relationship invoicing enabled, additional properties are returned in the response: ``` "customer_hierarchy_enabled": true, "whopays_enabled": true, "whopays_default_payer": "self" ``` For more information, see [Who Pays & Customer Hierarchy](https://maxio.zendesk.com/hc/en-us/articles/24252185211533-Customer-Hierarchies-WhoPays).
List Maxio.js (formerly Chargify.js) Public Keys GET
Lists public keys used for Maxio.js (formerly Chargify.js).