Products
Read Product by Handle
Retrieves a Product object by its api_handle.
Authorization
BasicAuth AuthorizationBasic <token>
The username is a Maxio Chargify API key. The password is x.
In: header
Path Parameters
api_handle*string
The handle of the product
Response Body
application/json
curl -X GET "https://example.com/products/handle/string.json"{ "product": { "id": 3903594, "name": "No cost product", "handle": "no-cost-product", "description": "", "accounting_code": "", "request_credit_card": true, "expiration_interval": null, "expiration_interval_unit": "never", "created_at": "2016-09-02T17:11:29-04:00", "updated_at": "2016-11-30T11:46:13-05:00", "price_in_cents": 0, "interval": 1, "interval_unit": "month", "initial_charge_in_cents": null, "trial_price_in_cents": 5, "trial_interval": 1, "trial_interval_unit": "month", "archived_at": null, "require_credit_card": false, "return_params": "reference=5678", "taxable": false, "update_return_url": "", "initial_charge_after_trial": false, "version_number": 1, "update_return_params": "reference=5678", "product_family": { "id": 527890, "name": "Acme Projects", "description": "", "handle": "billing-plans", "accounting_code": null }, "public_signup_pages": [ { "id": 281174, "return_url": "", "return_params": "", "url": "https://general-goods.chargify.com/subscribe/xgdxtk4vhtbz/no-cost-product" }, { "id": 282270, "return_url": "", "return_params": "", "url": "https://general-goods.chargify.com/subscribe/xxqmrgtsbd9k/no-cost-product" }, { "id": 291587, "return_url": "", "return_params": "", "url": "https://general-goods.chargify.com/subscribe/pvhwss7zjjnh/no-cost-product" }, { "id": 294832, "return_url": "http://www.example.com/", "return_params": "engine=md7a", "url": "https://general-goods.chargify.com/subscribe/m6tbcq4mcgpw/no-cost-product" } ], "product_price_point_name": "Default" }}Update Product PUT
Updates aspects of an existing product. ### Input Attributes Update Notes + `update_return_params` The parameters we will append to your `update_return_url`. See Return URLs and Parameters ### Product Price Point Updating a product using this endpoint will create a new price point and set it as the default price point for this product. If you should like to update an existing product price point, that must be done separately.
List Products GET
Lists products belonging to a site.