Maxio Advanced Billing
HomeSDKsAPI ReferenceContext Plugin
Products

Update Product

PUT
/products/{product_id}.json

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.

Authorization

BasicAuth
AuthorizationBasic <token>

The username is a Maxio Chargify API key. The password is x.

In: header

Path Parameters

product_id*integer

The Advanced Billing id of the product

Request Body

application/json

product*

Response Body

application/json

application/json

curl -X PUT "https://example.com/products/0.json" \  -H "Content-Type: application/json" \  -d '{    "product": {      "name": "string",      "description": "string",      "price_in_cents": 0,      "interval": 0,      "interval_unit": "day"    }  }'
{  "product": {    "id": 4365034,    "name": "Platinum Plan",    "handle": "platinum",    "description": "This is our platinum plan.",    "accounting_code": "123",    "request_credit_card": true,    "created_at": "2016-11-04T16:34:29-04:00",    "updated_at": "2016-11-04T16:37:11-04:00",    "price_in_cents": 1000,    "interval": 1,    "interval_unit": "month",    "initial_charge_in_cents": null,    "trial_price_in_cents": null,    "trial_interval": null,    "trial_interval_unit": null,    "archived_at": null,    "require_credit_card": true,    "return_params": null,    "taxable": false,    "update_return_url": null,    "initial_charge_after_trial": false,    "version_number": 1,    "update_return_params": null,    "product_family": {      "id": 527890,      "name": "Acme Projects",      "description": "",      "handle": "billing-plans",      "accounting_code": null    },    "public_signup_pages": [      {        "id": 301079,        "return_url": null,        "return_params": null,        "url": "https://general-goods.chargify.com/subscribe/wgyd96tb5pj9/platinum"      }    ],    "product_price_point_name": "Original"  }}

Archive Product DELETE

Archives the product. All current subscribers will be unaffected; their subscription/purchase will continue to be charged monthly. This will restrict the option to chose the product for purchase via the Billing Portal, as well as disable Public Signup Pages for the product.

Read Product by Handle GET

Retrieves a Product object by its `api_handle`.