Read Site
Retrieves site data.
For more information, see Sites in the product documentation. Specifically, the 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.
Authorization
BasicAuth The username is a Maxio Chargify API key. The password is x.
In: header
Response Body
application/json
curl -X GET "https://example.com/site.json"{ "site": { "id": 0, "name": "string", "subdomain": "string", "currency": "string", "seller_id": 0, "non_primary_currencies": [ "string" ], "relationship_invoicing_enabled": true, "schedule_subscription_cancellation_enabled": true, "customer_hierarchy_enabled": true, "whopays_enabled": true, "whopays_default_payer": "string", "default_payment_collection_method": "string", "organization_address": { "street": null, "line2": null, "city": null, "state": null, "zip": null, "country": null, "name": "string", "phone": "string" }, "tax_configuration": { "kind": "custom", "fully_configured": true, "destination_address": "shipping_then_billing" }, "net_terms": { "default_net_terms": 0, "automatic_net_terms": 0, "remittance_net_terms": 0, "net_terms_on_remittance_signups_enabled": false, "custom_net_terms_enabled": false }, "test": true, "allocation_settings": { "upgrade_charge": "prorated", "downgrade_credit": "none", "accrue_charge": "true" } }}Update Endpoint PUT
Updates an Endpoint. You can change the `url` of your endpoint or the list of `webhook_subscriptions` to which you are subscribed. See the [Webhooks Reference](https://maxio-test-wp.pages.dev/getting-started/webhooks/webhooks-reference#events) page for available events. Always send a complete list of events to which you want to subscribe. Sending a PUT request for an existing endpoint with an empty list of `webhook_subscriptions` will unsubscribe all events. If you want to unsubscribe from a specific event, send a list of `webhook_subscriptions` without the specific event key.
Clear Site Data POST
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.**